KPI

A KPI widget shows a single number.

Data shape

<kpi>

NQL structure

Refer to the Live Dashboards NQL examples documentation for query examples of KPI widgets.

Aggregation - most commonly used

...
summarize <kpi> = <sum() | count() | avg() | max() | min()>

Configuring visualization fields specific to KPI widgets

Refer to the Managing Live Dashboards documentation to learn how to fill in the remaining configuration fields that are not specific to this widget.

After selecting the KPI option from the Chart type drop-down in the Add widget/Edit a widget pop-up:

Use the Label (optional) field to create the visible name of the KPI metric.
- The text can contain special characters. There is a 50-character limit on the Label field.
Enter a Widget description (optional) to explain, for example, how the metric should be interpreted, calculated, or any subtleties to the metric.
- The widget description appears by hovering over the info icon next to the KPI widget in the dashboard.
If applicable, select the option to Display as percentage. The system multiplies the number by 100 and adds the percent symbol.
Establish Rating thresholds to add a colored icon to the KPI widget for quick visual identification of issues. Choose from:
- 1 threshold: the KPI displays the rating as either Good or Bad.
  - The system evaluates thresholds with the >= operator. The example above is evaluated as follows:
    Good: if the metric is < 0.2
    Bad: if the metric is >= 0.2
  - Select Invert to invert the good and bad conditions. When inverted, the example above is evaluated as follows:
    Bad: if the metric is < 0.2
    Good: if the metric is >= 0.2
- 2 thresholds: the KPI displays a rating in one of three states: Good, Average or Bad.
  - The system evaluates thresholds with the >= operator. The example above is evaluated as follows:
    Good: if the metric is < 0.1
    Average: if the metric is >= 0.1 AND the metric is < 0.4
    Bad: if the metric is >= 0.4
  - Select Invert to invert the good and bad conditions. When inverted, the example above is evaluated as follows:
    Bad: if the metric is < 0.1
    Average: if the metric is >= 0.1 AND the metric is < 0.4
    Good: if the metric is >= 0.4

Only enter numeric values for the thresholds, such as decimals and integers, positive or negative numbers. For typed values, refer to the following table as the unit of the threshold value:

Typed values

Threshold values

Percentages

Enter the threshold as a decimal. For example, 0.9 represents a threshold of 90%.

Duration

The threshold value is interpreted as the number of seconds.

Bytes

The threshold value is interpreted as the number of bytes.