Custom Metrics

Custom Metrics

Getting Started

In addition to integrated services such as Pingdom and New Relic, StatusCast allows you to post and display custom metrics. To create a custom metric log into your StatusCast admin portal, [yourapp].statuscast.com/admin and navigate to the Layout section. Once there drag the Metric wizard on your right and drop it into your page layout.

new metric

 

Select New Metric.

new metric form

Enter a Display name, choose a Custom provider, and enter your metric type. The metric type will be the unit of measurement that displays on your graph.

Select the the Save button, you will now be returned to your list of Metrics. You will notice an API Key displaying next to your newly created custom metric. You will need this key to post metrics to the system through the REST API.

 

metric saved

Now your statuspage will have a graph representing the custom metric data you send to StatusCast.

 

Posting Metrics

First, you will need to understand authentication for our REST API. To post a new metric to the system, send a POST request (with your basic authentication credentials) to [yourapp] statuscast.com//v1/metrics/custom with the following JSON:

metric example

The timestamp field can be sent in any of the following formats:

  • MM/dd/yyyy hh:mm:ss tt
  • yyyy-MM-dd hh:mm:ss tt
  • hh:mm
  • hh:mm:ss

More information about the metrics API

If you refresh the status page, you will see a representation of the new datapoint on the graph. Keep in mind that graph data is cached, so graphs will not immediately present metrics upon posting. It may take up to 10 minutes for the new datapoint to display on the graph.