A Tile is used to configure and visualize different metrics using the basic or advanced PromQL or OpsQL query builder. A collection of tiles is called a Dashboard.

The following steps let you create a Tile visualization from a query:

  1. Create the dashboard.

  2. Select from the following tiles:

    • Metric
    • Text & Image
    • Resource
    • Alert
    • Service Tile
  3. Build a PromQL or OpsQL query using the basic or advanced query building to populate your visualization. In the basic query option, the metrics, filters, operations, attributes, and values are displayed and you can build the query by clicking +QUERY field and selecting each value from the drop down list. For example, consider the following:

    • Metric = system_cpu_load
    • Filter = avg
      PromQL Basic Query Building Example

    In the advanced query option, build a query by clicking the </> to use the advanced query builder and start typing the query and complete the query. For example, consider the following:

    • Attribute = status
    • Operator = =
    • Value = Open
      OpsQL Advanced Query Building Example

  4. Select from the available chart types:

    • Line/Bar - displays multiple time series as a graph or bar graphic.
    • Single Value - displays a single value.
    • List - displays values in a list format.
    • Gauge - displays multiple time series using a gauge graphic.
    • Honeycomb - displays multiple time series in a hexbin or hexagonal graphic.
    • Pie - displays values in a pie graph.
  5. Customize the visualization.

  6. View the dashboard on the main dashboard page.

Tiles

The following are the available Tiles in Dashboard 2.0 version:

TileDescription
Metric
  • The aggregate monitor value is shown for the given metric.
  • Search for the metrics using the PromQL query and view the results in the following formats:
    • Line/Bar
    • Single Value
    • List
    • Gauge
    • Honeycomb
  • Click the Legend to redirect the visualization to the Resources details page.
  • Click the Legend for Line/Bar and List visualizations.
  • Click the image for Gauge and Honeycomb visualizations.
  • This option is not available for Single Value visualizations.
  • Note: The Metric tile is supported only at the client-level.
Text & Image
  • A Text tile is used to create a text.
  • Click the Data tab to create the text.
  • An Image Tile is used to upload Images.
  • Click the Visualization tab to upload images.
Resource
  • Provides information about the breakdown of resources.
  • Note: A list of resources available in the Infrastructure is displayed under the Type header.
  • Search for the resources using the OpsQL query to view the resources specific to the search criterion.
  • By default, the resources are categorized by the Type attribute. You can select up to a maximum of two attributes in the Group By field.
  • This option is available for Pie and List visualizations only.
    • Pie: In the optional Legend field, select the options that will be displayed as attributes next to the numerical values.
    • Single Value: View the search results as a single value.
    • List: If you select more than one attribute, an additional attribute column is displayed. Sort the fields by group, ascending or descending order.
  • Click the count to see the list of resources.
Alert
  • Provides information about the breakdown of alerts.
  • Search for the alerts using the OpsQL query. View the results in the following formats:
    • Pie
    • Single Value
    • List
  • Click the count to see the list of alerts.
Service Availability
  • Provides information regarding the availability of the services defined in the service maps.
  • Note: Service tile is only available at Partner context.

Create a Metric Tile

  1. From 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.

      • You can filter a metric based on a resource group.

        While building the query:

      • Select the metric and then 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.
        Note: 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.

        • You can filter a metric based on a Site.
          While building the query:

        • Select the metric and then 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
        • You can 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 then 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 shows 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. Alternatively, 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.
  2. 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.
  3. Click the optional Legend icon and enter {{ in the Query a Legend field to see a list of options.
  4. 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.

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

Create an Alert Tile

  1. From 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 ALERT.
    The following screen is displayed:

Add Alert Tile Screen
  1. Click the + QUERY and select the attributes from the drop-down list as you build the query. Click the + button to add additional attributes.
    • You can combine multiple filters together to view only the required alerts.
      The query is completed and the results are displayed in the preview graph.
  2. Alternatively, click </> to use the advanced query builder.
    Click </> again to close the advanced query field and switch back to the basic query builder format.
  3. Enter a query or click inside the box to see a list of OpsQL attributes.
  4. Click the optional Legend icon and enter {{ in the EDIT LEGEND field to see a list of options.
  5. Select the visualization from the following options:
    • Pie - Displays a pie chart.
    • Single Value - Displays a single value.
    • List - Displays values in a list format.
  6. From the GROUP BY option, select an attribute. You can select up to two attributes.
    In the List visualization, the second attribute values are displayed in a multi-column colored list.
    The following is a sample illustration of a multi-column list:
    Multi Column List View of Alert Tile
  7. Enable the Split subgroups toggle to view each grouping as a separate row.
    Notes:
    • The multi-column list and split subgroup options are available for List chart only.
    • The colors are displayed based on the default color categorization of alerts.
    • Click the count or any column in the multi-column list to drill down and see the contextual list of alerts in the alerts browser.
  8. Select the time range from the Apply dashboard time range to option to view the alerts graphs based on:
    • Alert created time: Alerts are filtered based on the alert created time and the graph is displayed.
    • Alert updated time: Alerts are filtered based on the alert updated time and the graph is displayed.
  9. You can also customize the visualization.
  10. 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, and Month to Date.
  11. Click Create.
    The Alert tile is created and displayed on the main dashboard page.

Examples

The following are example illustrations for each visualization:

PIE visualization

The following is the PIE chart visualization with the inputs:

  • Attribute - currentState = OK
  • Group By
    • Attribute 1 = status
    • Attribute 2 = resource.name
  • Legend - {{make}}
  • Dashboard time range = Alert created time
  • Duration = Last 8 Hours
Pie Chart View of Alert Tile

PIE dashboard view

The following is the PIE chart dashboard view:

Dashboard View of Alert Tile Pie Chart

SINGLE VALUE visualization

The following is the SINGLE VALUE visualization with the inputs:

  • Attribute - currentState = OK
  • Dashboard time range = Alert created time
  • Duration = Last 8 Hours
    Single Value View of Alert Tile

SINGLE VALUE dashboard view

The following is the SINGLE VALUE dashboard view:

Single Value of Alert Tile Dashboard View

LIST visualization

The following is the LIST visualization with the inputs:

  • Attribute - currentState = OK
  • Group By
    • Attribute 1 = status
    • Attribute 2 = resource.name
  • Dashboard time range = Alert created time
  • Duration = Last 8 Hours
  • Split subgroups = enabled
List View of Alert Tile

The Split subgroups option displays results with the attribute name. The following is a sample illustration:

Alert Tile List View with Split subgroups

LIST dashboard view

The following is the LIST dashboard view:

List Value of Alert Tile Dashboard View

Create a ServiceTile

  1. From 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 SERVICE.

    The following screen is displayed:

Service Tile
  1. In the SERVICE section, you have the below drop-downs:
FunctionalityDescription
CLIENTThe Client information is displayed

Notes:
  • By default All Clients are selected.
  • You may also click the CLIENT drop-down and select the SERVICE from the drop-down list for the client.
SERVICESelect the partner information from the drop-down list.

Note: By default All Services is selected.
Service Tile
  1. (Optional), click the ALL CLIENTS drop-down and click the Selected Clients radio button.

    Note: At the dashboard level when you change All Clients to a specific client, and select the same client from Selected Clients, in the service tile that specific client data is populated.

  2. (Optional) select the client from the drop-down list, and click APPLY.

Service Tile
  1. Select the partner name from the SERVICE drop-down list.

    Note: By default the Group Services is enabled, click the Grouped Services icon to disable.

Service Tile
  1. Click the Visualization tab to customize the visualization further:
    • 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.

    • Attribute: Select the color for the attribute, the size, bold or Italics.

Service Tile
  1. Click CREATE. The Service tile is created and displayed on the main dashboard page.

Tile Options

The following Tile options are available in the More Tile Options menu (three horizontal dots) next to a tile view in the main dashboard.

Tile OptionDescription
EditEdits a tile.
CopyCopies a tile.
View JSONViews the tile in a JSON file format.
RemoveRemoves a tile.

Create Dashboard Variables

Dashboard variables are created to assign specific attributes. These are used to filter the data with different attributes, without creating a new tile every time a change is required.

To create a variable, do the following:

  1. Select a dashboard or create a new dashboard.
  2. Click Filter in the main dashboard page. The MANAGE option appears.
  3. Click MANAGE. The MANAGE VARIABLE pop-up page appears. In this page following are the supported filter options:
    • Metric
    • Resource
    • Alert
  4. Select one of the filter options and provide the values to create variables. The following is an example:
    • Variable Name - Vendor
    • Attribute Name - make
    • Default Value - select a value from the drop-down list
      Variables Display in a Query
  5. Click + to add the variable. The new variable is added and displayed on the main dashboard page.
  6. You can perform the following actions on the variable:
    • Edit - click to edit the variable, and then click the tick mark to save the changes.
    • Remove - click to remove the variable.

Click X to close the MANAGE and RESET options menu and view the toolbar.

6. Now, you can use the newly created variable with the tile.
7. Create a Metric, Resource, or Alert tile by clicking + on the dashboard page. The new variable will be available for selection.

Variables Display in a Query
7. To edit the variable, enable the Custom Filter option and then click Filter. The chart is automatically updated with the new data.
8. To apply the same filter data to the dashboard, enable the option Apply tile filter to dashboard.
9. To use the previous value, click RESET.