Create a Metric Tile

  1. From Dashboard > Dashboard 2.0, create a new dashboard or select from an existing dashboard collection.

    See Create Dashboards to learn about creating dashboards.

  2. Click CREATE TILE or + from the toolbar.

  3. In the ADD TILE screen that appears, select METRIC.
    The following screen is displayed:

Add Metric Tile Screen
  1. Click the + QUERY and select the options from the following drop-down lists as you build the query:
    • Metrics - Select any metric that is being sent to OpsRamp or an OpsRamp-generated metric.

    • Filters - Select to filter the metrics based on the tags or labels that are present on those metrics.

      Resource group

      • Filter metrics based on a resource group.

        While building the query:

      • Select the metric and click +Filters.

      metric-tile-groups-filter
      • Select groups from the list of tags.
        Note: You can also search using the search box.

      • Select the operator and the value. The metric tile shows the metric details based on the resource group.

      • You can also use a dashboard variable as a value.

      metric-tile-groups-dashboard-variable

      Note: A resource can be a part of one group or multiple groups. These groups appear as a comma-separated list in the metric series.

      Sites

      • Filter metrics based on a Site.

        While building the query:

      • Select the metric and click +Filters.

      metric-tile-sites-filter
      • Select sites from the list of tags. You can also search using the search box. Select the operator and the value. The metric tile shows the metric details based on the site.

      • You can also use a dashboard variable as a value.

      metric-tile-sites-dashboard-variable

      Service Map name

      • Filter a metric by the service map name.

        While building the query:

      • Select the metric and click +Filters.

      Metric tile - service group
      • Select servicegroups from the list of tags. You can also search using the search box. Select the operator and the value. The metric tile shows the metric details based on the service map.

      • If a resource is added in two service maps, then the service groups data should be seen in comma-separated values.

      • You can also use a dashboard variable as a value.

      Custom Attributes

      • Use custom attributes when querying metrics.
        Define custom attributes on the resources. Use these custom attributes to graph metric data.
        Example: View the CPU, memory, disk metrics for a specific group of resources that are tagged with specific custom attributes. While building the query:

      • Select the metric and click +Filters.

        metric-tile-custom-attribute-filter
      • Select the custom attribute, the operator and the value from the list of tags.

        Note: You can also search using the search box.

      • The metric tile displays the metric series for all the resources that are tagged with the custom attributes for the specific metric.

        Note: When creating a custom attribute value (in the Setup > Custom Attributes page), select the Metric Label checkbox. Only then the custom attribute will be considered as a label for the resource metrics.

        metric-label-custom-attribute-value
      • It takes 24 hours for the custom attribute labels to be displayed on the metric series.

      • If you do not select the Metric Label checkbox while creating a custom attribute value, it will not be visible when you edit the custom attribute value.

      • Metric label enabled custom attributes have limits. A maximum of 5 metric labels can be enabled per device.

      • The metric label enabled custom attributes are displayed in the resource details page, in the Attributes section. This will allow you to decide which of the custom attributes you can consider as a label for the metrics.

        Click here for more information on Custom Attributes.

  • Operations - You can select a maximum of two operations ranging from aggregations such as average or summation to mathematical functions like logarithms or absolute values. You can use min, max, avg, topk for the series generated.
    The preview graph is displayed as you build the query.
  1. Advance Query - click </> to use the advanced query builder. Click </> again to close the advanced query field and switch to the basic query builder format.
    Note: If you make changes in the advanced query builder, you cannot switch back to the basic query builder.

    • Start typing a query and choose either a function or metric from the dropdown that appears, if you are using the advanced query option.
      See QUERYING PROMETHEUS to learn about PromQL queries.
    • Y-Axis Scaling: Y-axis dynamically adjusts when multiple queries are added, enabling effective comparison between queries with different ranges of values.
      The following is the Y-Axis Scaling visualization with the inputs:
      • Metric A = acs_rds_MySQL_ActiveSessions
      • Metric B = acs_rds_MySQL_ibufRequestW
    Y-Axis Scaling
  • Forecast Graph: The forecast graph provides flexibility for you to specify a Prometheus query expression, enabling you to predict and visualize the forecasted value of time series data for the given metric.

    • You can also seamlessly navigate from any metric tile, with the specific time frame and relevant tags, to the log explorer simplifying the task of correlating metric data with log data, ensuring a streamlined and contextually relevant experience.

      1. Hover over the graph and click on any point, the VIEW LOGS is displayed.
      2. Click VIEW LOGS.
        Note: click the VIEW LOGS again to close the drilldown.
    Y-Axis Scaling

    Note: A maximum of 10 days can be predicted.

    Below is an example query using promql expression to display the forecast of a metric.

    Metric A: predict_linear(system_disk_utilization{host="device1"}[5d], 30*24*60*60)
    In the above example,

PROMQL ValueDescription
predict_linearpromql expression to forecast the metric data.
system_disk_utilizationmetricName for which the time series forecasting is to be visualized.
hostDevice name for which the forecast is to be visualized
"5d"Forecasting future window to predict and display the metric data for the next 5 days. Users can define based on the required prediction time period.
30*24*60*60Learning time window, to look back 30 days of data to generate the forecasting analysis trend.
Forecast Graphs
    • Change Detection: The change detection provides flexibility in visualizing change detection patterns. You can now define the below expressions in your Prometheus query to generate and visualize the change detected occurrences.
        • Upper limit.
        • Actual Value.
        • Lower Limit.
      Below is an example of how these expressions are used to show change detection in the metric tile:

      UpperLimit: avg_over_time(system_cpu_utilization{host=“QA-WIN12HYD-KL01”, instance=“CPU”}[4h])) + 3*(stddev_over_time(system_cpu_utilization{host=“QA-WIN12HYD-KL01”, instance=“CPU”}[4h]))

      Actual Value: system_cpu_utilization{host=“QA-WIN12HYD-KL01”, instance=“CPU”}

      For LowerLimit: avg_over_time(system_cpu_utilization{host=“QA-WIN12HYD-KL01”, instance=“CPU”}[4h])) - 3*(stddev_over_time(system_cpu_utilization{host=“QA-WIN12HYD-KL01”, instance=“CPU”}[4h]))

      In the above example,

      PROMQL ValueDescription
      "system_cpu_utilization"metricName.
      "4h"The learning duration, which users can customize between 1h to 24h based on the requirements.
      "3"Sensitivity factor which is the multiple of standard deviations from the mean value, users can give any number but the recommended value would be below 10.
Time Independence
  1. Click the optional Legend icon and enter {{ in the Query a Legend field to see a list of options.
  2. Select the data type from the following options:
Chart TypeDescription
Line/BarDisplays a time series graph with metric values collected over a time interval.
Value (single value)Displays a single value.
ListDisplays values in a list format.
GaugeDisplays multiple time series using a gauge graphic.
HoneycombDisplays multiple time series in a hexagonal graphic.
  1. Click SAVE to view the results based on your selection. Hover over the results on the preview graph to view them individually.

  2. Select the Value option to view the results as a single value. If there are more than one series, the single value does not display.

  3. You can sort the queries in ascending or descending order. This option is available for the List visualization.

  4. Select the Instant toggle to view the recent value for a given metric.

    Note: The Instant option is available only for List, Gauge, and Honeycomb chart types.

  5. To customize the visualization further, click the Visualization tab.

    • HEADER: Set a name, color, size, and alignment for the header.
    • Grid Lines: Select the color of the grid lines, enable or disable the grid lines by clicking the toggle ON or OFF, Grid Lines option.
      Note: By default the Grid Lines is enabled
    • Background Color: Select the background color, enable or disable the background color by clicking the toggle ON or OFF background color.
      Note: By default the Background Color is disabled.
    • LABELS AND THRESHOLDS:
FunctionalityDescription
Label NameFunctionality
Metric ValueChoose the color, size, postfix, and the decimal value.
Metric LabelsChoose the color and size for the Metric Labels.
ValueThe Show as label checkbox is selected by default.
Note: Uncheck the Show as label checkbox to view as number
    • +THRESHOLD: Enter the range for the Threshold, All the options like >, <, or a range like 1-4, or a value like 8 can be entered.

      Note: The +THRESHOLD option is only available for the List Tile

    • Select the Background color and enter the Default Label value.

Service Tile
  1. Click the Last Hour to select the duration for which the data needs to be retrieved. The duration can be selected for:
    • Last Hour
    • Last 4 Hours
    • Last 8 Hours
    • Last 24 Hours
    • Last 7 Days
    • Last 30 Days
    • Month to Date.
  2. Click Create.
    The Metric tile is created and displayed on the main dashboard page.

Examples

The following are example illustrations for each visualization:

LINE/BAR visualization

The following is the LINE/BAR visualization with the inputs:

  • Metric = system_resource_availability_state
  • Filter = state = up
  • Legend = uuid
Line Bar Chart View

LINE/BAR dashboard view

The following is the LINE/BAR dashboard view:

Line Bar Dashboard View

VALUE (single value) visualization

The following is the VALUE (single value) visualization with the inputs:

  • Metric = system_resource_availability_state
  • Filter = make of the resource
  • Operations = avg
Single Value Chart View

VALUE (single value) dashboard view

The following is the VALUE (single value) dashboard view:

Single Value Dashboard View

LIST visualization

The following is the LIST visualization with the inputs:

  • Metric A = system_resource_availability_state
  • Metric B = system_service_map_availability_state
  • Filters for:
    • Metric A = state = up
    • Metric B = state = up
  • Operations for:
    • Metric A = count
    • Metric B = avg
  • Legend for Metric A and B = {{uuid}}
  • Sort By = Descending
List Value Chart View

LIST dashboard view

The following is the LIST dashboard view:

List Value Dashboard View

GAUGE visualization

The following is the GAUGE visualization with the inputs:

  • Metric = system_service_map_availability_state
Gauge Chart View

GAUGE dashboard view

The following is the GAUGE dashboard view:

Gauge Dashboard View

HONEYCOMB visualization

The following is the HONEYCOMB visualization with the inputs:

  • Metric = system_os_uptime
Honeycomb Chart View

HONEYCOMB dashboard view

The following is the HONEYCOMB dashboard view:

Honeycomb Dashboard View

Text value display for resource and service availability

For the system_resource_availability_state and system_service_map_availability_state metrics, the status is displayed as both label (text) and numeric value. The following are the values:

  • Up
  • Down
  • Unknown
  • Degraded

By default, the status is shown as a text value. To view the status as a numeric value, clear the Show as label selection in the Visualization tab.

Show as Label Option

The text status display option is available for List, Gauge, and Honeycomb visualizations only.

system_resource_availability_state

The system_resource_availability_state metric monitors the availability of the resources and displays the status as a numeric or text value. The following are the available values:

  • 1 - Unknown
  • 3 - Down
  • 4 - Up

Sample Illustrations
The following are the sample illustrations for each visualization and its respective dashboard view:

LIST visualization

The following is the LIST visualization:

Resource Availability List View

LIST dashboard view
The following is the LIST dashboard view:

Resource Availability List Dashboard View

GAUGE visualization
The following is the GAUGE visualization:

Resource Availability Gauge View

GAUGE dashboard view
The following is the GAUGE dashboard view:

Resource Availability Gauge Dashboard View

HONEYCOMB visualization

The following is the HONEYCOMB visualization:

Resource Availability Honeycomb View

HONEYCOMB dashboard view
The following is the HONEYCOMB dashboard view:

Resource Availability Honeycomb Dashboard View

system_service_map_availability_state

The system_service_map_availability_state metric monitors the availability of the service maps and displays the status as a numeric or text value. The following are the available values:

  • 2 - Degraded
  • 3 - Down
  • 4 - Up

Sample Illustrations
The following are the sample illustrations for each visualization and its respective dashboard view:

LIST visualization

The following is the LIST visualization:

Service Map Availability List View

LIST dashboard view
The following is the LIST dashboard view:

Service Map Availability List Dashboard View

GAUGE visualization

The following is the GAUGE visualization:

Service Map Availability Gauge View

GAUGE dashboard view

The following is the GAUGE dashboard view:

Service Map Availability Gauge Dashboard View

HONEYCOMB visualization

The following is the HONEYCOMB visualization:

Service Map Availability Honeycomb View

HONEYCOMB dashboard view
The following is the HONEYCOMB dashboard view:

Service Map Availability Honeycomb Dashboard View