metrics icon

Custom metrics management and dashboard

Version: 17.07

Custom metrics management

The custom metrics management view displays all the custom metrics streams defined by the current user as well as the streams shared publicly by other users. To access this dashboard, click on the Custom Metrics item from the main menu and then click on the Manage Dashboard Widgets (1) button.

metrics menu
manage btn

This tabular view displays the below information of each metrics stream in addition to a set of action buttons.

manage table

Name (1)

The name of the metrics stream widget

Field Name (2)

The metrics field name used for the widget

Stream Name (3)

The metrics stream name used for the widget

Scale (4)

The scaling factor defined for Y axis of the graph

Created by (5)

The name of the user who created this widget

Public (6)

Whether this widget is publicly shared or private

Pinned (7)

Whether this widget is pinned to the current user’s dashboard

The action buttons provide the following functionality for each metrics widget.

View Stream (8)

View the metrics stream graph with its configurations

View Config (9)

View the metrics stream configurations

Edit (10)

Edit the metrics stream widget (only available for the widgets created by the current user)

Make public/private (11)

Switch the public/private state of the metrics stream widget (only available for the widgets created by the current user)

Pin to dashboard (12)

Pin/Unpin the widget from the dashboard

Remove (13)

Remove the metrics stream widget (only available for the widgets created by the current user)

The search box (14) can be used to search streams based on name, field name and stream name. In addition, button (15) can be used to navigate to the metrics dashboard and button (16) can be used to define a new metrics stream.

Custom metrics dashboard

The custom metrics dashboard, that can be accessed by clicking on the Custom Metrics item from the main menu displays all the pinned custom metrics streams in graphical representations.

metrics menu

A single such metrics stream will be shown as follows.

custom metrics graph

The time range picker (1) can be used to select a time range for which the metrics data will presented. The graph at the center (2) provides a graphical representation of the metrics stream within that selected time range. Below the graph aggregated minimum, maximum, average and total values (3) for the time range will be shown (total is shown only if the widget is configured to show it).

The view configuration button (4) will display the configuration values of the metrics stream widget and unpin button (5) will unpin this widget from the dashboard.

In this topic
In this topic
Contact Us