-
Task
-
Resolution: Done
-
Critical
-
None
This issue tracks the following changes meant to improve the content in the existing API access section of the monitoring docs:
- include the existing procedure module located at https://docs.openshift.com/container-platform/4.15/monitoring/enabling-monitoring-for-user-defined-projects.html#accessing-metrics-from-outside-cluster_enabling-monitoring-for-user-defined-projects
- revise existing API access procedure to be consistent with the accessing metrics from outside the cluster topic and to align the formatting with the guidance from the OCP docs guidelines.
- Add the following Important admonition to the beginning of the section in the assembly adoc file:
[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, follow these recommendations:
- Avoid querying endpoints frequently. Limit queries to a maximum of one every 30 seconds.
- Do not try to retrieve all metrics data via the `/federate` endpoint. Query it 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.====
- links to
(1 links to)