Skip to content

Commit 0d73bb5

Browse files
committed
RHDEVDOCS 3420 - Show Monitoring target info in UI admin perspective
1 parent ded791b commit 0d73bb5

6 files changed

+114
-1
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1998,6 +1998,8 @@ Topics:
19981998
File: enabling-monitoring-for-user-defined-projects
19991999
- Name: Managing metrics
20002000
File: managing-metrics
2001+
- Name: Managing metrics targets
2002+
File: managing-metrics-targets
20012003
- Name: Managing alerts
20022004
File: managing-alerts
20032005
- Name: Reviewing monitoring dashboards
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * monitoring/managing-metrics-targets.adoc
4+
5+
[id="monitoring-accessing-the-metrics-targets-page_{context}"]
6+
= Accessing the Metrics Targets page in the Administrator perspective
7+
8+
You can view the *Metrics Targets* page in the *Administrator* perspective in the {product-title} web console.
9+
10+
.Prerequisites
11+
12+
* You have access to the cluster as an administrator for the project for which you want to view metrics targets.
13+
14+
.Procedure
15+
16+
* In the *Administrator* perspective, select *Observe* -> *Targets*.
17+
The *Metrics Targets* page opens with a list of all service endpoint targets that are being scraped for metrics.
18+
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * monitoring/managing-metrics-targets.adoc
4+
5+
[id="getting-detailed-information-about-a-target_{context}"]
6+
= Getting detailed information about a target
7+
8+
On the **Target details** page, you can view detailed information about a metric target.
9+
10+
.Prerequisites
11+
12+
* You have access to the cluster as an administrator for the project for which you want to view metrics targets.
13+
14+
.Procedure
15+
16+
*To view detailed information about a target in the Administrator perspective*:
17+
18+
. Open the {product-title} web console and navigate to *Observe* -> *Targets*.
19+
20+
. Optional: Filter the targets by status and source by selecting filters in the *Filter* list.
21+
22+
. Optional: Search for a target by name or label by using the *Text* or *Label* field next to the search box.
23+
24+
. Optional: Sort the targets by clicking one or more of the *Endpoint*, *Status*, *Namespace*, *Last Scrape*, and *Scrape Duration* column headers.
25+
26+
. 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:
27+
+
28+
--
29+
** The endpoint URL being scraped for metrics
30+
** The current *Up* or *Down* status of the target
31+
** A link to the namespace
32+
** A link to the ServiceMonitor details
33+
** Labels attached to the target
34+
** The most recent time that the target was scraped for metrics
35+
--
36+
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * monitoring/managing-metrics-targets.adoc
4+
5+
[id="monitoring-searching-and-filtering-metrics-targets_{context}"]
6+
= Searching and filtering metrics targets
7+
8+
The list of metrics targets can be long. You can filter and search these targets based on various criteria.
9+
10+
In the *Administrator* perspective, the *Metrics Targets* page provides details about targets for default {product-title} and user-defined projects.
11+
This page lists the following information for each target:
12+
13+
* the service endpoint URL being scraped
14+
* the ServiceMonitor component being monitored
15+
* the up or down status of the target
16+
* the namespace
17+
* the last scrape time
18+
* the duration of the last scrape
19+
20+
You can filter the list of targets by status and source. The following filtering options are available:
21+
22+
* *Status* filters:
23+
** *Up*. The target is currently up and being actively scraped for metrics.
24+
** *Down*. The target is currently down and not being scraped for metrics.
25+
26+
* *Source* filters:
27+
** *Platform*. Platform-level targets relate only to default {product-title} projects. These projects provide core {product-title} functionality.
28+
** *User*. User targets relate to user-defined projects. These projects are user-created and can be customized.
29+
30+
You can also use the search box to find a target by target name or label.
31+
Select *Text* or *Label* from the search box menu to limit your search.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
[id="managing-metrics-targets"]
2+
= Managing metrics targets
3+
include::modules/common-attributes.adoc[]
4+
:context: managing-metrics-targets
5+
6+
toc::[]
7+
8+
{product-title} Monitoring collects metrics from targeted cluster components by scraping data from exposed service endpoints.
9+
10+
In the *Administrator* perspective in the {product-title} 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.
11+
For example, you can view the current status of targeted endpoints to see when {product-title} Monitoring is not able to scrape metrics from a targeted component.
12+
13+
The *Metrics Targets* page shows targets for default {product-title} projects and for user-defined projects.
14+
15+
// Accessing the Metrics Targets UI in the Administrator perspective
16+
include::modules/monitoring-accessing-the-metrics-targets-page.adoc[leveloffset=+1]
17+
18+
// Searching and filtering metrics targets
19+
include::modules/monitoring-searching-and-filtering-metrics-targets.adoc[leveloffset=+1]
20+
21+
// Getting detailed information about metrics targets
22+
include::modules/monitoring-getting-detailed-information-about-a-target.adoc[leveloffset=+1]
23+
24+
== Next steps
25+
26+
* xref:../monitoring/managing-alerts.adoc#managing-alerts[Managing alerts]

monitoring/managing-metrics.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ include::modules/monitoring-exploring-the-visualized-metrics.adoc[leveloffset=+2
3333

3434
== Next steps
3535

36-
* xref:../monitoring/managing-alerts.adoc#managing-alerts[Managing alerts]
36+
* xref:../monitoring/managing-metrics-targets.adoc#managing-metrics-targets[Managing metrics targets]

0 commit comments

Comments
 (0)