IBM RMF query languages

In Grafana, queries are essential for fetching and transforming data from RMF data sources.

Executing a query is a process that involves defining the data source, specifying the desired data to retrieve, and applying relevant filters or transformations. IBM RMF for z/OS Grafana plugin provides a user-friendly RMF query editor that maximizes its unique capabilities. Grafana panels retrieve data for visualization from RMF data sources via queries.

You can use the following types of queries to retrieve data from the specified RMF data source:

  • Metric query – Use this query to retrieve RMF Monitor III metrics.
  • Report query – Use this query to retrieve RMF Monitor III reports.

Metric query syntax

The syntax of the Metric query is as follows:

resource_type.metric_description {qualifications}

Where:
  • resource_type is the type of resource for which information is requested. You must enter the appropriate value in the resource_type field.

    The available resource types are documented in the z/OS RMF Monitor III resource model topic in the z/OS Resource Measurement Facility Programmer's Guide.

  • metric_description is the name of the metric for the selected resource type.

    After entering the resource type, you can choose the metric description from the drop-down list.

  • qualifications is an optional parameter and can contain any or all the following attributes separated by a comma:
    • ulq: The name of the resource type at the upper level.
    • name: The name of the resource.
    • filter: The filter helps to focus on the data of your interest when requesting a list of values.
      You can use one of the following values for the filter attribute:
      PAT=< pattern>
      Specifies one or more patterns that must match the name part of a list element.
      LB=<number>
      Specifies a lower bound value. Only list elements with values higher than the given lower bound are returned.
      UB=<number>
      Specifies an upper bound value. Only list elements with values lower than the established upper bound are returned.
      HI=<integer>
      Only the highest <integer> list elements are returned (mutually exclusive with LO).
      LO=<integer>
      Only the lowest <integer> list elements are returned (mutually exclusive with HI).
      ORD=< NA | ND | VA | VD | NN>
      • NA - Sort the list of names by their names in ascending order.
      • ND – Sort the list of names by their names in descending order.
      • VA – Sort the list of values by their values in ascending order.
      • VD – Sort the list of values by their values in descending order.
      • NN - If you do not want to have any order, you can specify ORD=NN.
    • workscope: To qualify a request for performance data in more detail about address spaces and WLM entities. You can use one of the following values for the workscope attribute:
      • G - Global (no workscope required)
      • W - WLM workload
      • S - WLM service class
      • P - WLM service class period
      • R - WLM report class
      • J - Job

Examples:

SYSPLEX.% total physical utilization (AAP) by partition
COUPLING_FACILITY.% processor utilization
CPC.% total physical utilization (shared IIP)
MVS_IMAGE.% delay by WLM report class period {name=RS21}
MVS_IMAGE.% workflow by WLM report class period {ulq=RS21,name=RS2*,filter=ORD=NA,workscope=,,G}

Report query syntax

The syntax of the Report query is as follows:

resource_type.REPORT.report_name

Where:
  • resource_type is the type of resource for which information is requested. You must enter the appropriate value in the resource_type field.
  • report_name is the name of the report.

    You can find the report names in the Interactive performance analysis with Monitor III, which is documented in the z/OS Resource Measurement Facility Report Analysis.

    Note: You can view reports on the Grafana dashboard only for the resource types SYSPLEX and MVS_IMAGE.

Examples:

SYSPLEX.REPORT.CACHSUM
SYSPLEX.REPORT.CPC