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
  3. Build a PromQL or OpsQL query using the basic or advanced query building to populate your visualization.
  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.
  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
MetricNote: The Metric tile is supported only at the client-level.
Aggregate monitor value is shown for the given metric. Search for the metrics using the PromQL query. 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.
Text & ImageA 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.
ResourceProvides information about the breakdown of resources. 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.
AlertProvides 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.

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

  4. 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.
    • Operations - You can select multiple operations ranging from aggregations such as average or summation to mathematical functions like logarithms or absolute values.
      The preview graph is displayed as you build the query.
  5. 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.
  6. 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 https://prometheus.io/docs/prometheus/latest/querying/basics/ to learn about PromQL queries.
  7. Click the optional Legend icon and enter {{ in the EDIT LEGEND field to see a list of options.
  8. Select the data type from the following options:
    • Line/Bar - Displays a time series graph with metric values collected over a time interval.
    • Value (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 hexagonal graphic.
  9. Select an option and click SAVE to view the results based on your selection. Hover over the results on the preview graph to view them individually.
  10. 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.
  11. You can sort the queries in ascending or descending order. This option is available for the List visualization.
  12. Select the Instant toggle to view the recent value for a given metric.
    The Instant option is available only for List, Gauge, and Honeycomb chart types.
  13. To customize the visualization further, click the Visualization tab.
  14. 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.
  15. 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

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
  4. 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.
  5. 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.
  6. Enter a query or click inside the box to see a list of OpsQL attributes.
  7. Click the optional Legend icon and enter {{ in the EDIT LEGEND field to see a list of options.
  8. 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.
  9. 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
  10. 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.
  11. 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.
  12. You can also customize the visualization.
  13. 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.
  14. 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

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 and in the MANAGE VARIABLE pop-up, 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

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

  4. Click +. The new variable is added and displayed on the main dashboard page.
    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.
  5. Create a Resource or an Alert tile. The newly created variable will be available for selection.

    Variables Display in a Query

  6. To edit the variable, click the variable from the main dashboard and select a different attribute from the list. Alternatively, click MANAGE and edit from the Actions. The chart is updated automatically with the changed data.

  7. To use the previous value, click RESET.