Using BMC Helix Dashboards

BMC Helix Dashboards provides the ability to create interactive dashboards for BMC Helix Continuous Optimization data. You can customize the dashboards in multiple ways to gain valuable insights into your system. BMC Helix Dashboards enhance the set of analysis supported by BMC Helix Continuous Optimization by providing additional customization capabilities for graphical representation. 

BMC Helix Dashboards offer unified reporting that gives you a consolidated view of data from the integrated products, such as BMC Helix Continuous Optimization and BMC Helix Operations Management. You can create dashboards that source data from applications across your environment. You can easily export and share dashboards with users within or outside your environment. You can also use template variables to reuse dashboard panels. For more information about the dashboards, see the BMC Helix Dashboards documentation.

 

Related topics

Analyzing-the-memory-utilization-of-Kubernetes-pods-by-using-BMC-Helix-Dashboards

Visualizing-the-overall-health-and-status-of-the-business-services

Checking-the-ETL-health-for-optimal-data-collection

Visualizing-the-predictive-time-series-data-of-BMC-Helix-Continuous-OptimizationGrafana documentation

Metrics browserPrometheus QL

Out-of-the-box dashboards

Use the out-of-the-box dashboards to quickly start visualizing and analyzing data in your environment. The following out-of-the-box dashboards are available for BMC Helix Continuous Optimization:

Solaris Dashboard

Use the Solaris Dashboard to visualize and analyze the capacity data of your Solaris infrastructure. For details, see Solaris Dashboard.

Service Risk Dashboard 

Use the out-of-the-box Service Risk Dashboard to get insights into the overall health and status of business services and view the prediction data. For details, see Service Risk Dashboard.

Storage Capacity Dashboards

Use the Storage Capacity Dashboards to visualize and analyze the capacity data of your storage systems. For details, see Storage Capacity dashboards.

Nutanix dashboards

Use the Nutanix Dashboards to get visibility into your monitored Nutanix environment. The organized panels present key capacity metrics and charts of Nutanix components for capacity analysis. For details, see Nutanix dashboards.

OpenStack dashboards

Use the OpenStack Dashboards to get visibility into your monitored Nutanix environment. The organized panels present key capacity metrics and charts of OpenStack components for capacity analysis. For details, see OpenStack dashboards.

 

To create custom dashboards for BMC Helix Continuous Optimization in BMC Helix Dashboards

Based on your business needs, configure custom dashboards, panels, and queries to start creating visualizations to get an insight into your IT infrastructure. As a tenant administrator or an editor, you need to build queries in panels in BMC Helix Dashboards to fetch data from the data source. You can build multiple queries with different query types in a panel. However, you cannot change the data source for each query in a panel. To change the data source, you must create a new panel. You can also select a visualization type for the panel.

  1. Log in to BMC Helix Portal as a capacity planner.
    Make sure that the Editor role is assigned to the capacity planner user.
  2. Click the BMC Helix Dashboards tile.
  3. Do one of the following:
    • On the Home page, click create_icon.pngand select New Dashboard.
    • From the navigation menu, click Dashboards. Then click New > New Dashboard.
  4. On the New dashboard page, click Add visualization.
  5. In the Query section, select the BMC Helix data source for the query.
  6. In the Query Type field, select one of the following query types to fetch the relevant BMC Helix Continuous Optimization data:
  7. In the Query field, add the query. This field changes according to the query type you select.
  8. (optional) To add an additional query, click + Query, and specify the query options as described in the previous step.
  9. Select the required visualization type.
  10. Enter a name for the dashboard, select a folder, and click Save. The new dashboard with the relevant data is displayed.

To visualize the Continuous Optimization data based on metrics

Use the Metric query type to fetch the performance metrics data in your environment.

  1. Add a new panel and select Query Type as Metrics.
  2. Configure the following parameters, and save the query:

Field

Description

Query type

Select the query type as Metric.

Source

Select the source as Optimize.
using_dashboards_22.2.png

Metrics browser

Type a metric query to this field or expand the metric browser to build basic queries by using required metrics and labels.

As you type your query, you will receive label suggestions based on the available metrics. The following video explains how to use the metrics browser to build a basic query.

Video attachment not found.

Following is a list of some of the labels that you can use for BMC Helix Continuous Optimization:

  • metric (string): VictoriaMetric metric name using the label as "__name__".
  • entid (number): Identifier of the entity, such as sysid, wkldid, and appid.
  • entname (string): Name of the entity. It could vary over time. 
  • enttype (string): Entity type, such as system, application, or business driver types. You can use the entity prefix in the query. For example, to extract data for  Virtual Cluster - VMware entity type, use the enttype as sys:vh:vmw. For information on all entity types supported in  BMC Helix Continuous Optimization, see Entity-types.
  • resname (string): Label for the monitored resource. For example, filesystem "/root", disk "sda", interface "eth0".
  • restype (string): Type of the resource defined in the resname label. For example storage:filesystem, storage:disk, network:interface.
  • resid (uuid, string): UUID of the resource.
  • source (string): Use when multiple sources load the same metric without overwriting each other sample possible values.
    • "opt:meas":  measured generic
    • "opt:meas:vn": virtual node
    • "opt:der": derived series
    • "opt:mod": model
    • "opt:ind": indicator
  • inputstat (string): Statistic used for the metric, such as avg, min, max, and value.

For examples of the metric query type, see Examples.

Legend

Add a legend to appear in the panel.

You can use a variable here. For example, the value of the {~code language="none"}}hostname{{/code} variable is replaced with the host name in the panel.

Min step

Add a threshold for a lower limit of the Prometheus query. This setting is absolute and cannot be changed by the value in the Resolution field.

Resolution

Sets the parameter for each pixel to correspond to one data point of a Prometheus range query. Use lower resolutions for better performance.

For more information, see Prometheus data source.

Format

Select one of the following formats for the panel:

  • Time Series
  • Table
  • Heatmap

Instant

Use this toggle button to return only the latest value for the requested time series. Instant queries return results faster than the normal range queries.

Examples of the Metric query type

Here are a few examples of the Metric query type:

Use case

Query

Visualization type

Output panel

View the memory utilization details for the Kubernetes cluster.

MEM_UTIL{enttype="sys:kubernetes:cluster", entname="$Cluster"} * 100

Gauge

dashboards_ex1.png

 

View the pod usage within the Kubernetes cluster.

(SUM(KPOD_NUM{entname="$Cluster"})/
SUM(KPOD_NUM_MAX{entname="$Cluster"}))*100

Gauge

dashboards_ex2.png

 

View the CPU and memory utilization details for Kubernetes nodes.

  • (CPU_UTIL{enttype="sys:kubernetes:node"})
  • (MEM_UTIL{enttype="sys:kubernetes:node"})

Table

dashboards_ex3.png

 

View the CPU usage trend for the Kubernetes cluster.

  • CPU_USED_NUM{enttype="sys:kubernetes:cluster", entname="$Cluster"} 
  • CPU_LIMIT{enttype="sys:kubernetes:cluster", entname="$Cluster"}
  • CPU_REQUEST{enttype="sys:kubernetes:cluster", entname="$Cluster"}
  • CPU_NUM{enttype="sys:kubernetes:cluster", entname="$Cluster"}

Time series

dashboards_ex4.png

To visualize the Continuous Optimization data retrieved from the data mart or Analysis service

Use the Optimize Services query type to fetch the capacity data from a data mart or the Analysis service.

To visualize data retrieved from a data mart

  1. Add a new panel and select Query Type as Optimize Services.
  2. From the Service list, select Datamarts.

  3. Configure the following parameters, and save the query:
     

    Field

    Description

    Datamarts browser

    Select a data mart from the list. Use the search box to quickly locate the required data mart.

    Click the status icon (22.3_datamart_normal_status.png indicates the normal status, 22.3_datamart_warning_status.pngindicates the warning status, and 22.3_datamart_error_status.pngindicates the error status) corresponding to a data mart to view the data mart details, such as ID, type, and status.

    Select Time Filter

    If the time filter selection is available for the data mart, select a period for which you want to retrieve data from the data mart. For some data marts, the time filter is preconfigured and it cannot be changed.

    Domain Filter

    Filter data based on specific domains by using domain filters. For example, you can display only those systems with domains "AWS".

    Use the search box or domain picker to locate the required domain quickly. Select the required domains and sub-domains. The panel displays the entities of only the selected domains and subdomains. 

    Tag Filter

    Filter data based on a specific tag by using tag filters. For example, you can display only those systems with tags "high" and "VMware".

    Use the search box to quickly locate the required tag. Select the required tags. The panel displays the entities specific to the selected tags. 

To visualize data retrieved from the Analysis service

  1. Add a new panel and select Query type as Optimize Services.
  2. From the Service list, select Analysis.

  3. Configure the following parameters, and save the query:
     

    Field

    Description

    System Id

    Specify a comma-separated list of IDs of the systems from which you want to retrieve data. You can also enter a variable.

    Metrics

    Specify a comma-separated list of metrics that you want to retrieve. For example, CPU_UTL and MEM_UTL

(Optional) Filter data mart contents by using variables

Variables act as placeholders and get values at run time. They can be based on any data source. You can use them to filter data mart contents. For example, if you want to create a variable to filter the content of a data mart column named Cluster, perform these tasks:

Task 1: To find the data mart ID and internal column name

  1. Open the dashboard that you created for visualizing the data mart content.
  2. Expand the data mart table title and click Edit.
  3. Note down the data mart ID as shown in the following image:

    23.3_datamart_id_for_variable.png
     
  4. On the Transform tab, note down the internal column name as shown in the following image:

    23.3_int_column_name_for_variable.png

Task 2: To create the variable

  1. On a custom dashboard, click Dashboard settings dashboard_settings_icon.png.
  2. On the Settings page, click Variables.
  3. Click Add new variable and specify the following values:
    1. Name: Internal name of the column to be filtered. For example, clustername.
    2. Label: Label to be used as a display name for the filter. For example, Cluster.
    3. Data source: BMC Helix API
    4. Query options: 
      1. On the Path tab, select POST and specify the URL of the API to retrieve data for the filter by using the column name and data mart ID.
        Example: /opt/api/v1/datamartservice/datamarts/<data mart ID>/filters/<column name>
      2. On the Body tab, specify the filters and options to customize the API response.
        Example: {"filters":[],"options":{"pagenum":0,"pagesize":-1}}
      3. On the Fields tab, specify the values that you want to filter. For example, specify these options to filter by column ID:
        1. In the Field box, specify values.id.
        2. Select JSONata.
          You can view the list of IDs under Preview of values.
    5. Refresh: On dashboard load
    6. Sort: Disabled
    7. Selection options: Select both options.
  4. Click Apply. The new variable is created and displayed at the top of the data mart table. You can use it to filter the data mart column.

For details on APIs used for entity filters, see Datamart-API-endpoints and Analysis API endpoints.

Example: Variable used as a filter
  1. Create a variable named Cluster to filter a list of vSphere clusters in the Cluster column.

    23.3_variable_as_filter.png
     
  2. Use the variable to select specific clusters from the list.

    23.3_variable_as_filter_selection.png

    The dashboard displays data for the selected clusters.

    23.3_variable_filter_result.png

To filter data based on specific domains by using variables

Filter the dashboard data based on specific domains at runtime by configuring the domain filter in a variable. You can also share the filtered dashboard report with relevant stakeholders based on their domain preferences. For example, you can display only those systems with the domain as AWS in the dashboard.

For details on variables, see Setting up variables for dashboard queries.

Scenario

Paul is a capacity planner in Apex Global company that uses BMC Helix Continuous Optimization to manage the capacity of its infrastructure. They also use BMC Helix Dashboards to create and view interactive dashboards for BMC Helix Continuous Optimization data. 

Paul manages and shares capacity management dashboards with internal and external stakeholders. As he is responsible for multiple domains, he wants a way to filter and analyze the data on the dashboard based on a specific domain at a time. He also wants to share the dashboard report with respective stakeholders based on the domains they are interested in. 

He requests Alan, an administrator, to configure the domain filter in a variable so that he can use it in the dashboard to filter the data based on a specific domain. 

Task 1: To create the variable

  1. On a custom dashboard, click Dashboard settings dashboard_settings_icon.png.
  2. On the Settings page, click Variables.
  3. Click + New variable and specify the following values:
    1. Select variable type: Optimizer variable 
    2. Name: appid
      Important: Make sure that you do not enter any other name than appid. 
    3. Label: Label that will be displayed as a filter in the dashboard. For example, Domain.
    4. Show on dashboard: Label and value
    5. Select optimizer variable type: Domain filter 
  4. Click Apply.
    The new variable is created and displayed at the top of the dashboard. 

domain_picker_24.3.png

Task 2: To filter data based on specific domains

  1. Click the domain filter at the top of the dashboard to locate the required domain quickly.

    1_domain_24.3.png 
     
  2. Use the search box or domain picker to locate the required domain quickly.
    You can use an asterisk as a wildcard.
    Select the required domains and subdomains. 

    2_domain_24.3.png

The dashboard displays data for only the selected domains. 

3_domain_24.3.png

 

 

Cross-launch from BMC Helix Continuous Optimization to BMC Helix Dashboards

With the integration of BMC Helix Continuous Optimization with BMC Helix Dashboards, you can navigate to BMC Helix Dashboards by using the cross-launch option from the Views section of BMC Helix Continuous Optimization. The cross-launch option is available on the details page of the systems that are monitored by the PATROL Agent. You can view the device metrics data in BMC Helix Dashboards with this feature. This option is not available for systems that are not monitored by the PATROL Agent.

To view the option for your devices in BMC Helix Continuous Optimization, make sure that BMC Helix Operations Management, BMC Helix Dashboards, and BMC Helix Discovery are available on the same tenant. Make sure that you have the permission to view the device metric details in BMC Helix Dashboards.

bhco_bhd_cross_launch_edited.png

 

 

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*