Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OBSDOCS-1552: Add assembly content for 'Accessing metrics' section #86759

Merged
merged 1 commit into from
Jan 8, 2025
+64 −4
Merged

OBSDOCS-1552: Add assembly content for 'Accessing metrics' section #86759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion observability/monitoring/accessing-metrics/accessing-metrics-as-a-developer.adoc
View file
Open in desktop
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]



18 changes: 17 additions & 1 deletion ...ability/monitoring/accessing-metrics/accessing-metrics-as-an-administrator.adoc
View file
Open in desktop
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]



36 changes: 35 additions & 1 deletion ...ty/monitoring/accessing-metrics/accessing-monitoring-apis-by-using-the-CLI.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,41 @@ include::_attributes/common-attributes.adoc[]

toc::[]

TBD
Copy link
Contributor Author

@eromanova97 eromanova97 Jan 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the clarification due to the GitHub render here: The content here is just copy-pasted from the observability/monitoring/accessing-third-party-monitoring-apis.adoc assembly file. No changes added. This PR only moves things around.

(The only difference is not including the xrefs yet)

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.
eromanova97 marked this conversation as resolved.
Show resolved Hide resolved

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
2 changes: 1 addition & 1 deletion observability/monitoring/accessing-third-party-monitoring-apis.adoc
View file
Open in desktop
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]
Copy link
Contributor Author

@eromanova97 eromanova97 Jan 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This module is commented out in the old assembly due to the module not having the "context" part in its ID, which was breaking the build. This cannot be currently changed for the scope of this PR, because the module is automatically generated and needs changes in another repository first. This will not cause any issues though and can be done later, as this old assembly will be eventually deleted before publishing.



[role="_additional-resources"]
Expand Down