Creating a Query

Define a query to retrieve data from Monitoring.

For an example query, see Example Query and Metric Chart.

For query troubleshooting, see Troubleshooting Queries.

  • These steps show how to create a query in the Metrics Explorer page, in Basic mode. To create a query in Advanced mode (MQL), see Editing the MQL Expression for a Query.

    1. Open the navigation menu and click Observability & Management. Under Monitoring, click Metrics Explorer.
      The Metrics Explorer page displays an empty chart with fields to build a query.
    2. From the Console header, select the region that contains the metric data that you want.
      For more information about regions, see Understand Regions and Working Across Regions.
    3. In the query under the chart, select the compartment that contains the metric that you want.
    4. Select the metric namespace that contains the metric that you want.

      The Metric namespace list shows metric namespaces for the selected compartment. For example, if the current compartment contains load balancers, then the list includes oci_lbaas.
    5. Select the name of the metric.
    6. Update the interval or statistic as needed.
    7. (Optional) To select dimensions, provide values for the following fields:
      • Dimension name: A qualifier specified in the metric definition. For example, the dimension resourceId is specified in the metric definition for CpuUtilization.
      • Dimension value: The value that you want to use for the specified dimension, for example, the resource identifier for an instance.
      • Additional dimension: Adds another name-value pair for a dimension.
    8. (Optional) To aggregate metric streams, select Aggregate metric streams.
    9. Click Update Chart.
      The chart shows data points for the custom metric, in a graph view. Example:Metric streams and values in a graph.
    10. (Optional) To switch to a table view, click Show Data Table.
      The chart shows data points for the custom metric, in a table view.

    For information about directly editing MQL expressions or changing queries by using the CLI or API, see Editing the MQL Expression for a Query.

  • Use the oci monitoring metric-data summarize-metrics-data command and required parameters to query metric data:

    oci monitoring metric-data summarize-metrics-data [OPTIONS]

    When specifying a dimension value within the query (--query-text), surround it with double quotes, and escape each double quote with a backslash character (\). Example:

    oci monitoring metric-data summarize-metrics-data --compartment-id <compartment_OCID> --namespace oci_computeagent --query-text "CpuUtilization[1m]{resourceId = \"<instance_OCID>\"}.max()"

    For a complete list of parameters and values for CLI commands, see the Command Line Reference for Monitoring.

  • Run the SummarizeMetricsData operation to query metric data.