You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
= Resources reference for the Cluster Monitoring Operator
9
9
10
10
This document describes the following resources deployed and managed by the Cluster Monitoring Operator (CMO):
@@ -16,16 +16,13 @@ Use this information when you want to configure API endpoint connections to retr
16
16
17
17
[IMPORTANT]
18
18
====
19
-
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.
19
+
In certain situations, accessing 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.
20
20
21
21
To avoid these issues, follow these recommendations:
22
22
23
23
* Avoid querying endpoints frequently. Limit queries to a maximum of one every 30 seconds.
24
-
* Do not try to retrieve all metrics data via the `/federate` endpoint for Prometheus.
25
-
Query it only when you want to retrieve a limited, aggregated data set.
26
-
For example, retrieving fewer than 1,000 samples for each request helps minimize the risk of performance degradation.
24
+
* 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.
27
25
====
28
-
29
26
[id="cmo-routes-resources"]
30
27
== CMO routes resources
31
28
@@ -72,7 +69,8 @@ Expose the user-defined Alertmanager web server within the cluster on the follow
72
69
73
70
Expose the Alertmanager web server within the cluster on the following ports:
74
71
75
-
* Port 9094 provides access to all the Alertmanager endpoints. Granting access requires binding a user to the `monitoring-alertmanager-view` role (for read-only operations) or the `monitoring-alertmanager-edit` role in the `openshift-monitoring` project.
72
+
* Port 9094 provides access to all the Alertmanager endpoints. Granting access requires binding a user to the `monitoring-alertmanager-view` (for read-only operations) or `monitoring-alertmanager-edit` role in the `openshift-monitoring` project.
73
+
76
74
* Port 9092 provides access to the Alertmanager endpoints restricted to a given project. Granting access requires binding a user to the `monitoring-rules-edit` cluster role or `monitoring-edit` cluster role in the project.
77
75
* Port 9097 provides access to the `/metrics` endpoint only. This port is for internal use, and no other usage is guaranteed.
78
76
@@ -107,7 +105,6 @@ Expose openshift-state-metrics `/metrics` endpoints within the cluster on the fo
107
105
Expose the Prometheus web server within the cluster on the following ports:
108
106
109
107
* Port 9091 provides access to all the Prometheus endpoints. Granting access requires binding a user to the `cluster-monitoring-view` cluster role.
110
-
111
108
* Port 9092 provides access to the `/metrics` and `/federate` endpoints only. This port is for internal use, and no other usage is guaranteed.
@@ -137,7 +134,7 @@ Expose the Thanos Querier web server within the cluster on the following ports:
137
134
138
135
* Port 9091 provides access to all the Thanos Querier endpoints. Granting access requires binding a user to the `cluster-monitoring-view` cluster role.
139
136
* Port 9092 provides access to the `/api/v1/query`, `/api/v1/query_range/`, `/api/v1/labels`, `/api/v1/label/*/values`, and `/api/v1/series` endpoints restricted to a given project. Granting access requires binding a user to the `view` cluster role in the project.
140
-
* Port 9093 provides access to the `/api/v1/alerts`, and `/api/v1/rules` endpoints restricted to a given project. Granting access requires binding a user to the `monitoring-rules-edit` cluster role, `monitoring-edit` cluster role or `monitoring-rules-view` cluster role in the project.
137
+
* Port 9093 provides access to the `/api/v1/alerts`, and `/api/v1/rules` endpoints restricted to a given project. Granting access requires binding a user to the `monitoring-rules-edit`, `monitoring-edit`, or `monitoring-rules-view` cluster role in the project.
141
138
* Port 9094 provides access to the `/metrics` endpoint only. This port is for internal use, and no other usage is guaranteed.
Copy file name to clipboardExpand all lines: observability/monitoring/accessing-third-party-monitoring-apis.adoc
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ In certain situations, accessing API endpoints can degrade the performance and s
16
16
To avoid these issues, follow these recommendations:
17
17
18
18
* Avoid querying endpoints frequently. Limit queries to a maximum of one every 30 seconds.
19
-
* Do not try to retrieve all metrics data via the `/federate` endpoint for Prometheus. 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.
19
+
* Do not try to retrieve all metrics data through the `/federate` endpoint for Prometheus. 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.
20
20
====
21
21
22
22
// Accessing service APIs for third-party monitoring components
* xref:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#granting-user-permissions-using-the-web-console_enabling-monitoring-for-user-defined-projects[Granting user permissions by using the web console]
84
84
* xref:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#granting-user-permissions-using-the-cli_enabling-monitoring-for-user-defined-projects[Granting user permissions by using the CLI]
85
-
* xref:../../observability/monitoring/accessing-third-party-monitoring-apis.adoc#resources-reference-for-the-cluster-monitoring-operator[Resources reference for the {cmo-full}]
85
+
* xref:../../observability/monitoring/accessing-third-party-monitoring-apis.adoc#resources-reference-for-the-cluster-monitoring-operator_accessing-monitoring-apis-by-using-the-cli[Resources reference for the {cmo-full}]
0 commit comments