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

Note: Metric tiles, when displaying dynamic metric data that frequently changes, is updated every 90 seconds, i.e., every 3 minutes.

  1. Select one of the following:
Tile OptionFunctionality
Build my ownVisualize metrics coming in from your resources, cloud services, custom integrations, or any OpsRamp service.
Top Metric UtilizationVisualize top 10 resources by Metric Utilization.
Time SeriesVisualize the time series Metric Data.
Metric ValueVisualize the overall average CPU utilization of resources.
Distribution by MetricVisualize distribution of resources by CPU utilization.

Build My Own

Click here to view how to Build Your Own Query
  1. Select the Build my own tab. This enables you to create a custom tile.
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.

    • 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.
    Note: You can add upto three queries, however, you will no longer be able to create additional ones.
  1. You can sort the queries in ascending or descending order. This option is available for the List visualization.

  2. 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.

  3. 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 15 Days
    • Last 30 Days
    • Month to Date
  4. See Visualization to know on how to customize the Metric Tile.

  5. Click Create.
    The Metric tile is created and displayed on the main dashboard page.

Top Metric Utilization

Click here to view how to Top Metric Utilization
  1. Select the Top Metric Utilization tab.
Add Metric Tile Screen
  1. The default PROMQL query is already generated. Below is the PromQL:

        topk(10,avg by (uuid,instance,name,__name__)({type="RESOURCE",performanceType="CPU"}))
    
        

  • To find maximum/minimum CPU utilization in an hour for a resource:

      min_over_time | (min by     | (uuid,instance,name)      | ({performanceType="CPU", | type="RESOURCE"})  | [1h:])
      VALUE SORT    | (value by   | (data tag sort sequence)  | (metric on resource.     | Select Query)      | Duration
    
      

    Examples:

      * min_over_time(max by (uuid,instance,name) ({performanceType="CPU",type="RESOURCE"})[1h:])
    
      * max_over_time(max by (uuid,instance,name) ({performanceType="CPU",type="RESOURCE"})[1h:])
    
      

  • To find average CPU utilization in an hour for a resource:

      avg_over_time | (avg by     | (uuid,instance,name)      | ({performanceType="CPU", | type="RESOURCE"})  | [1h:])
      VALUE SORT    | (value by   | (data tag sort sequence)  | (metric on resource.     | Select Query)      | Duration
    
      

    Example:

      * avg_over_time(max by (uuid,instance,name) ({performanceType="CPU",type="RESOURCE"})[1h:])
    
      

    Note: You also have the option to edit the PROMQL.

Add Metric Tile Screen
  1. See Visualization to know on how to customize the Metric Tile.
  2. Click Create.
    The Metric tile is created and displayed on the main dashboard page.

Time Series

Click here to view how to Time Series
  1. Select the Time Series tab.
Add Metric Tile Screen
  1. The default PROMQL query is already generated. Below is the PromQL:
avg_over_time(system_cpu_utilization{type="RESOURCE"}[1h])

Note: You also have the option to edit the PROMQL.

Add Metric Tile Screen
  1. You may also add logs_ingestion_usage metric. This feature enables you to track and visualize logs usage for the selected clients across different sources, levels, and hosts.
Add Metric Tile Screen
  1. See Visualization to know on how to customize the Metric Tile.
  2. Click Create.
    The Metric tile is created and displayed on the main dashboard page.

Metric Value

Click here to view how to Metric Value
  1. Select the Metric Value tab.
Add Metric Tile Screen
  1. The default PROMQL query is already generated. Below is the PromQL:
avg(last_over_time(system_cpu_utilization{type="RESOURCE"}[1h]))

Note: You also have the option to edit the PROMQL.

Add Metric Tile Screen
  1. See Visualization to know on how to customize the Metric Tile.
  2. Click Create.
    The Metric tile is created and displayed on the main dashboard page.

Distribution by Metric

Click here to view how to Distribution by Metric
  1. Select the Distribution by Metric tab.
Add Metric Tile Screen
  1. The default PROMQL query is already generated. Below are the PromQL:
count((max({performanceType="CPU"}) by (uuid)) > 0 <= 40)
count((max({performanceType="CPU"}) by (uuid)) > 40 <= 80)
count((max({performanceType="CPU"}) by (uuid)) > 80 <= 100)

Note: You also have the option to edit the PROMQL.

Add Metric Tile Screen
  1. See Visualization to know on how to customize the Metric Tile.
  2. Click Create.
    The Metric tile is created and displayed on the main dashboard page.


Note: For a Partner user, if the All Clients option is selected, the METRIC tile will not be available for selection.

Visualization

  1. Click the Visualization tab to customize the visualization further:
  • TILE:
Label NameDescription
HEADERSet a name, color, size, and alignment for the header.
Grid LinesSelect 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 ColorSelect 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.
  • DISPLAY:
FunctionalityDescription
GraphChoose Line or Bar.
Note: When you select the Line graph, you can select the Line and Point Size.
Count DecimalSelect the Decimal count from the drop down list box.
Data Color MappingPer query, Time Series tile displays up to 30 series which are mapped to the order of this color chart. You may click a swatch to edit color or click+drag to reorder.
LegendSelect the color and the size of the Legent
Note: By default Legend checkbox is selected.
  • AXIS:
FunctionalityDescription
X-AXISEnter a name for the X-Axis.
Query AEnter the name for the Y-Axis.
Add Metric Tile Screen

Examples

  • See Value to view example illustrations for each visualization.
  • See Line/Bar to view example illustrations for each visualization.
  • See List to view example illustrations for each visualization.
  • See Honeycomb to view example illustrations for each visualization.
  • See Guage to view example illustrations for each visualization.