From dff3235f2c331811b209cbdd74b95674ac8ab0a2 Mon Sep 17 00:00:00 2001 From: Eliska Romanova Date: Tue, 7 Jan 2025 13:33:39 +0100 Subject: [PATCH] OBSDOCS-1552: Add assembly content for 'Accessing metrics' section --- .../accessing-metrics-as-a-developer.adoc | 12 ++++++- ...accessing-metrics-as-an-administrator.adoc | 18 +++++++++- ...sing-monitoring-apis-by-using-the-CLI.adoc | 36 ++++++++++++++++++- ...accessing-third-party-monitoring-apis.adoc | 2 +- 4 files changed, 64 insertions(+), 4 deletions(-) diff --git a/observability/monitoring/accessing-metrics/accessing-metrics-as-a-developer.adoc b/observability/monitoring/accessing-metrics/accessing-metrics-as-a-developer.adoc index d5baaa5aab1e..fb5f6213c6c0 100644 --- a/observability/monitoring/accessing-metrics/accessing-metrics-as-a-developer.adoc +++ b/observability/monitoring/accessing-metrics/accessing-metrics-as-a-developer.adoc @@ -6,8 +6,18 @@ include::_attributes/common-attributes.adoc[] toc::[] -TBD +You can access metrics to monitor the performance of your cluster workloads. +//Querying metrics for user-defined projects with the OCP web console +include::modules/monitoring-querying-metrics-for-user-defined-projects-with-mon-dashboard.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources + +* link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Querying Prometheus (Prometheus documentation)] + +//Reviewing monitoring dashboards as a developer +include::modules/monitoring-reviewing-monitoring-dashboards-developer.adoc[leveloffset=+1] diff --git a/observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc b/observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc index 49deea6d963f..78cac92017e0 100644 --- a/observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc +++ b/observability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc @@ -6,8 +6,24 @@ include::_attributes/common-attributes.adoc[] toc::[] -TBD +You can access metrics to monitor the performance of cluster components and your workloads. +//Viewing a list of available metrics +include::modules/monitoring-viewing-a-list-of-available-metrics.adoc[leveloffset=+1] + +//Querying metrics for all projects with the OCP web console +include::modules/monitoring-querying-metrics-for-all-projects-with-mon-dashboard.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources + +* link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Querying Prometheus (Prometheus documentation)] + +//Getting detailed information about a metrics target +include::modules/monitoring-getting-detailed-information-about-a-target.adoc[leveloffset=+1] + +//Reviewing monitoring dashboards as a cluster administrator +include::modules/monitoring-reviewing-monitoring-dashboards-admin.adoc[leveloffset=+1] diff --git a/observability/monitoring/accessing-metrics/accessing-monitoring-apis-by-using-the-CLI.adoc b/observability/monitoring/accessing-metrics/accessing-monitoring-apis-by-using-the-CLI.adoc index 01d7d84fb714..b9143f6e87a9 100644 --- a/observability/monitoring/accessing-metrics/accessing-monitoring-apis-by-using-the-CLI.adoc +++ b/observability/monitoring/accessing-metrics/accessing-monitoring-apis-by-using-the-CLI.adoc @@ -6,7 +6,41 @@ include::_attributes/common-attributes.adoc[] toc::[] -TBD +In {product-title}, you can access web service APIs for some monitoring components from the command-line interface (CLI). + +[IMPORTANT] +==== +In certain situations, accessing API endpoints can degrade the performance and scalability of your cluster, especially if you use endpoints to retrieve, send, or query large amounts of metrics data. + +To avoid these issues, consider the following recommendations: + +* Avoid querying endpoints frequently. Limit queries to a maximum of one every 30 seconds. +* Do not retrieve all metrics data through the `/federate` endpoint for Prometheus. Query the endpoint only when you want to retrieve a limited, aggregated data set. For example, retrieving fewer than 1,000 samples for each request helps minimize the risk of performance degradation. +==== + +// About accessing monitoring web service APIs +include::modules/monitoring-about-accessing-monitoring-web-service-apis.adoc[leveloffset=+1] + +// .Additional resources +// * TBD + +// Accessing a monitoring web service API +include::modules/monitoring-accessing-third-party-monitoring-web-service-apis.adoc[leveloffset=+1] + +// Querying metrics by using the federation endpoint for Prometheus +include::modules/monitoring-querying-metrics-by-using-the-federation-endpoint-for-prometheus.adoc[leveloffset=+1] + +// Accessing metrics from outside the cluster for custom applications +include::modules/accessing-metrics-outside-cluster.adoc[leveloffset=+1] + +// Resources reference for the Cluster Monitoring Operator +include::modules/monitoring-resources-reference-for-the-cluster-monitoring-operator.adoc[leveloffset=+1] + +// [role="_additional-resources"] +// [id="additional-resources_{context}"] +// == Additional resources + +// * TBD diff --git a/observability/monitoring/accessing-third-party-monitoring-apis.adoc b/observability/monitoring/accessing-third-party-monitoring-apis.adoc index ab66c640923d..f1fba1c97cd0 100644 --- a/observability/monitoring/accessing-third-party-monitoring-apis.adoc +++ b/observability/monitoring/accessing-third-party-monitoring-apis.adoc @@ -33,7 +33,7 @@ include::modules/monitoring-querying-metrics-by-using-the-federation-endpoint-fo include::modules/accessing-metrics-outside-cluster.adoc[leveloffset=+1] // Resources reference for accessing API endpoints -include::modules/monitoring-resources-reference-for-the-cluster-monitoring-operator.adoc[leveloffset=+1] +//include::modules/monitoring-resources-reference-for-the-cluster-monitoring-operator.adoc[leveloffset=+1] [role="_additional-resources"]