Skip to content

Commit

Permalink
OBSDOCS-1552: Add assembly content for 'Accessing metrics' section
Browse files Browse the repository at this point in the history
  • Loading branch information
eromanova97 committed Jan 8, 2025
1 parent f75aa7c commit dff3235
Show file tree
Hide file tree
Showing 4 changed files with 64 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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]



Original file line number Diff line number Diff line change
Expand Up @@ -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]



Original file line number Diff line number Diff line change
Expand Up @@ -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



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down

0 comments on commit dff3235

Please sign in to comment.