Soon, all Red Hat OpenShift documentation will only be available on docs.redhat.com, the official location of all Red Hat product documentation. Get familiar with the updated experience today!
  1. Documentation
×

Managing metrics targets

OKD Monitoring collects metrics from targeted cluster components by scraping data from exposed service endpoints.

In the Administrator perspective in the OKD web console, you can use the Metrics Targets page to view, search, and filter the endpoints that are currently targeted for scraping, which helps you to identify and troubleshoot problems. For example, you can view the current status of targeted endpoints to see when OKD Monitoring is not able to scrape metrics from a targeted component.

The Metrics Targets page shows targets for default OKD projects and for user-defined projects.

Accessing the Metrics Targets page in the Administrator perspective

You can view the Metrics Targets page in the Administrator perspective in the OKD web console.

Prerequisites

  • You have access to the cluster as an administrator for the project for which you want to view metrics targets.

Procedure

  • In the Administrator perspective, select Observe → Targets. The Metrics Targets page opens with a list of all service endpoint targets that are being scraped for metrics.

Searching and filtering metrics targets

The list of metrics targets can be long. You can filter and search these targets based on various criteria.

In the Administrator perspective, the Metrics Targets page provides details about targets for default OKD and user-defined projects. This page lists the following information for each target:

  • the service endpoint URL being scraped

  • the ServiceMonitor component being monitored

  • the up or down status of the target

  • the namespace

  • the last scrape time

  • the duration of the last scrape

You can filter the list of targets by status and source. The following filtering options are available:

  • Status filters:

    • Up. The target is currently up and being actively scraped for metrics.

    • Down. The target is currently down and not being scraped for metrics.

  • Source filters:

    • Platform. Platform-level targets relate only to default OKD projects. These projects provide core OKD functionality.

    • User. User targets relate to user-defined projects. These projects are user-created and can be customized.

You can also use the search box to find a target by target name or label. Select Text or Label from the search box menu to limit your search.

Getting detailed information about a target

On the Target details page, you can view detailed information about a metric target.

Prerequisites

  • You have access to the cluster as an administrator for the project for which you want to view metrics targets.

Procedure

To view detailed information about a target in the Administrator perspective:

  1. Open the OKD web console and navigate to Observe → Targets.

  2. Optional: Filter the targets by status and source by selecting filters in the Filter list.

  3. Optional: Search for a target by name or label by using the Text or Label field next to the search box.

  4. Optional: Sort the targets by clicking one or more of the Endpoint, Status, Namespace, Last Scrape, and Scrape Duration column headers.

  5. Click the URL in the Endpoint column for a target to navigate to its Target details page. This page provides information about the target, including:

    • The endpoint URL being scraped for metrics

    • The current Up or Down status of the target

    • A link to the namespace

    • A link to the ServiceMonitor details

    • Labels attached to the target

    • The most recent time that the target was scraped for metrics