Setting up service metrics

Teletraan offers the ability to specify metrics on an environment's page. You can specify a dashboard link to an existing dashboard from your visibility platform, or create a gauge visualization.

Dashboard

To provide a link to an existing dashboard:

1. Navigate to the Customize Metrics Page.

YourEnvironment -> Configure -> Metrics

2. Select 'Add Metric'.

3. **On the popup modal choose the "Dashboard" label and provide the HTML link to your dashboard on your visibility platform

4. Click 'Save', navigate to your Environment page, You should see the "Metrics" section with a "Dashboard" link button.

Gauge

The gauges reflect the very latest datapoint available from a specified url. This is useful for near real-time monitoring during a deploy.

1. Navigate to the Customize Metrics Page.

YourEnvironment -> Configure -> Metrics

2. Select 'Add Metric'.

3. On the popup modal choose a label and provide a specific url for your metric. The JSON response should look like the following example, including 'dps' or 'datapoints' keys:

[
    {
        various-misc-json-data...,
        dps: {
            timestamp: datapoint,
            timestamp: datapoint,
            ...,
        }
    }
]

or

[
    {
        various-misc-json-data...,
        datapoints: {
            timestamp: datapoint,
            timestamp: datapoint,
            ...,
        }
    }
]

4. After you have filled in your fields, click 'Add'. Teletraan will double check that your label is unique and that the url you provided returns the correct data. Your new metric will then be added to the metrics page.

5. You can customize gauge ranges with colors! For example, maybe you would like the gauge to reflect a certain color, like red, if the metric falls below a certain value to indicate something is awry.

Fill in the presented rows to specify green, yellow, and red ranges. If you don't want a specific color, simply set both min and max to 0.

If you just want to specify an upper bound with no colors, make the min == max for an unused color your upper bound, for instance: "Min: 9000 Max: 9000 Green/Red/Yellow"

Min represents the lower bound value for the color range.

Max represents the upper bound value for the color range.

NOTE: The overall upper range bound for your gauge is determined by the highest max you specify.

6. Click 'Save', navigate to your Environment page, and enjoy your slick new custom gauge(s)!