Chapter 2. Accessing metrics as a developer

Procedure

1. If you have not obtained the OpenShift Container Platform API route for Thanos Querier, run the following command:

   $ oc get routes -n openshift-monitoring thanos-querier -o jsonpath='{.status.ingress[0].host}'

2. Retrieve a list of metrics in JSON format from the Thanos Querier API route by running the following command. This command uses oc to authenticate with a bearer token.

   $ curl -k -H "Authorization: Bearer $(oc whoami -t)" https://<thanos_querier_route>/api/v1/metadata

   Replace <thanos_querier_route> with the OpenShift Container Platform API route for Thanos Querier.

Procedure

1. In the OpenShift Container Platform web console, click Observe Metrics.

2. To add one or more queries, perform any of the following actions:

   Expand

   Option	Description
   Select an existing query.	From the Select query drop-down list, select an existing query.
   Create a custom query.	Add your Prometheus Query Language (PromQL) query to the Expression field. As you type a PromQL expression, autocomplete suggestions appear in a drop-down list. These suggestions include functions, metrics, labels, and time tokens. Use the keyboard arrows to select one of these suggested items and then press Enter to add the item to your expression. Move your mouse pointer over a suggested item to view a brief description of that item.
   Add multiple queries.	Click Add query.
   Duplicate an existing query.	Click the options menu next to the query, then choose Duplicate query.
   Disable a query from being run.	Click the options menu next to the query and choose Disable query.

   Show more

3. To run queries that you created, click Run queries. The metrics from the queries are visualized on the plot. If a query is invalid, the UI shows an error message.

   Note
   • When drawing time series graphs, queries that operate on large amounts of data might time out or overload the browser. To avoid this, click Hide graph and calibrate your query by using only the metrics table. Then, after finding a feasible query, enable the plot to draw the graphs.
   • By default, the query table shows an expanded view that lists every metric and its current value. Click the ˅ down arrowhead to minimize the expanded view for a query.
4. Optional: Save the page URL to use this set of queries again in the future.

5. Explore the visualized metrics. Initially, all metrics from all enabled queries are shown on the plot. Select which metrics are shown by performing any of the following actions:

   Expand

   Option	Description
   Hide all metrics from a query.	Click the options menu for the query and click Hide all series.
   Hide a specific metric.	Go to the query table and click the colored square near the metric name.
   Zoom into the plot and change the time range.	Perform one of the following actions: Visually select the time range by clicking and dragging on the plot horizontally. Use the menu to select the time range.
   Reset the time range.	Click Reset zoom.
   Display outputs for all queries at a specific point in time.	Hover over the plot at the point you are interested in. The query outputs appear in a pop-up box.
   Hide the plot.	Click Hide graph.

   Show more

Procedure

1. In the Developer perspective of the OpenShift Container Platform web console, click Observe and go to the Dashboards tab.
2. Select a project from the Project: drop-down list.
3. Select a dashboard from the Dashboard drop-down list to see the filtered metrics.

4. Optional: Select a time range for the graphs in the Time range list.

   • Select a predefined time period.

   • Set a custom time range by clicking Custom time range in the Time range list.

     1. Input or select the From and To dates and times.
     2. Click Save to save the custom time range.
5. Optional: Select a Refresh interval.
6. Hover over each of the graphs within a dashboard to display detailed information about specific items.