diff --git a/about-ocp-monitoring/about-ocp-monitoring.adoc b/about-ocp-monitoring/about-ocp-monitoring.adoc index b1f06aa58c21..befe55513ade 100644 --- a/about-ocp-monitoring/about-ocp-monitoring.adoc +++ b/about-ocp-monitoring/about-ocp-monitoring.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] ifndef::openshift-dedicated,openshift-rosa[] {ocp} includes a preconfigured, preinstalled, and self-updating monitoring stack that provides monitoring for core platform components. You also have the option to xref:../configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[enable monitoring for user-defined projects]. diff --git a/about-ocp-monitoring/monitoring-stack-architecture.adoc b/about-ocp-monitoring/monitoring-stack-architecture.adoc index 6afeb6245b66..2cbcf3e68bed 100644 --- a/about-ocp-monitoring/monitoring-stack-architecture.adoc +++ b/about-ocp-monitoring/monitoring-stack-architecture.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] The {ocp} ifdef::openshift-rosa[] (ROSA) diff --git a/accessing-metrics/accessing-metrics-as-a-developer.adoc b/accessing-metrics/accessing-metrics-as-a-developer.adoc index 4fc9f041a092..9f0f8ae53fd2 100644 --- a/accessing-metrics/accessing-metrics-as-a-developer.adoc +++ b/accessing-metrics/accessing-metrics-as-a-developer.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] You can access metrics to monitor the performance of your cluster workloads. [role="_additional-resources"] diff --git a/accessing-metrics/accessing-metrics-as-an-administrator.adoc b/accessing-metrics/accessing-metrics-as-an-administrator.adoc index 0a3cc63e4ec2..1b00cfaf3f2c 100644 --- a/accessing-metrics/accessing-metrics-as-an-administrator.adoc +++ b/accessing-metrics/accessing-metrics-as-an-administrator.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] You can access metrics to monitor the performance of cluster components and your workloads. [role="_additional-resources"] diff --git a/accessing-metrics/accessing-monitoring-apis-by-using-the-cli.adoc b/accessing-metrics/accessing-monitoring-apis-by-using-the-cli.adoc index 8d35476a5e66..477579bb051a 100644 --- a/accessing-metrics/accessing-monitoring-apis-by-using-the-cli.adoc +++ b/accessing-metrics/accessing-monitoring-apis-by-using-the-cli.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] In {ocp}, you can access web service APIs for some monitoring components from the command-line interface (CLI). [IMPORTANT] diff --git a/configuring-core-platform-monitoring/configuring-alerts-and-notifications.adoc b/configuring-core-platform-monitoring/configuring-alerts-and-notifications.adoc index 0852f53627a2..493417b602a1 100644 --- a/configuring-core-platform-monitoring/configuring-alerts-and-notifications.adoc +++ b/configuring-core-platform-monitoring/configuring-alerts-and-notifications.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] You can configure a local or external Alertmanager instance to route alerts from Prometheus to endpoint receivers. You can also attach custom labels to all time series and alerts to add useful metadata information. //Configuring external Alertmanager instances diff --git a/configuring-core-platform-monitoring/configuring-metrics.adoc b/configuring-core-platform-monitoring/configuring-metrics.adoc index 9ad7ebe19102..3f14c7e17be4 100644 --- a/configuring-core-platform-monitoring/configuring-metrics.adoc +++ b/configuring-core-platform-monitoring/configuring-metrics.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] Configure the collection of metrics to monitor how cluster components and your own workloads are performing. You can send ingested metrics to remote systems for long-term storage and add cluster ID labels to the metrics to identify the data coming from different clusters. diff --git a/configuring-core-platform-monitoring/configuring-performance-and-scalability.adoc b/configuring-core-platform-monitoring/configuring-performance-and-scalability.adoc index 728ee42201b5..8a44f78268b0 100644 --- a/configuring-core-platform-monitoring/configuring-performance-and-scalability.adoc +++ b/configuring-core-platform-monitoring/configuring-performance-and-scalability.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] You can configure the monitoring stack to optimize the performance and scale of your clusters. The following documentation provides information about how to distribute the monitoring components and control the impact of the monitoring stack on CPU and memory resources. [role="_additional-resources"] diff --git a/configuring-core-platform-monitoring/preparing-to-configure-the-monitoring-stack.adoc b/configuring-core-platform-monitoring/preparing-to-configure-the-monitoring-stack.adoc index a2b8ca308ce6..6095542fb5bb 100644 --- a/configuring-core-platform-monitoring/preparing-to-configure-the-monitoring-stack.adoc +++ b/configuring-core-platform-monitoring/preparing-to-configure-the-monitoring-stack.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] The {ocp} installation program provides only a low number of configuration options before installation. Configuring most {ocp} framework components, including the cluster monitoring stack, happens after the installation. This section explains which monitoring components can be configured and how to prepare for configuring the monitoring stack. diff --git a/configuring-core-platform-monitoring/storing-and-recording-data.adoc b/configuring-core-platform-monitoring/storing-and-recording-data.adoc index aa84b9de8eb2..0e2716fd6910 100644 --- a/configuring-core-platform-monitoring/storing-and-recording-data.adoc +++ b/configuring-core-platform-monitoring/storing-and-recording-data.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] Store and record your metrics and alerting data, configure logs to specify which activities are recorded, control how long Prometheus retains stored data, and set the maximum amount of disk space for the data. These actions help you protect your data and use them for troubleshooting. // Configuring persistent storage diff --git a/configuring-user-workload-monitoring/configuring-alerts-and-notifications-uwm.adoc b/configuring-user-workload-monitoring/configuring-alerts-and-notifications-uwm.adoc index cc8b5163c144..92020aaae773 100644 --- a/configuring-user-workload-monitoring/configuring-alerts-and-notifications-uwm.adoc +++ b/configuring-user-workload-monitoring/configuring-alerts-and-notifications-uwm.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] You can configure a local or external Alertmanager instance to route alerts from Prometheus to endpoint receivers. You can also attach custom labels to all time series and alerts to add useful metadata information. //Configuring external Alertmanager instances diff --git a/configuring-user-workload-monitoring/configuring-metrics-uwm.adoc b/configuring-user-workload-monitoring/configuring-metrics-uwm.adoc index 3f5bec06f17d..b268e4a856d2 100644 --- a/configuring-user-workload-monitoring/configuring-metrics-uwm.adoc +++ b/configuring-user-workload-monitoring/configuring-metrics-uwm.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] Configure the collection of metrics to monitor how cluster components and your own workloads are performing. You can send ingested metrics to remote systems for long-term storage and add cluster ID labels to the metrics to identify the data coming from different clusters. diff --git a/configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc b/configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc index 91352ad8454d..6b150b757175 100644 --- a/configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc +++ b/configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] You can configure the monitoring stack to optimize the performance and scale of your clusters. The following documentation provides information about how to distribute the monitoring components and control the impact of the monitoring stack on CPU and memory resources. [id="controlling-placement-and-distribution-of-monitoing-components_{context}"] diff --git a/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc b/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc index 1c1b8eb880b6..4b9200a19c6e 100644 --- a/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc +++ b/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] This section explains which user-defined monitoring components can be configured, how to enable user workload monitoring, and how to prepare for configuring the user workload monitoring stack. [IMPORTANT] diff --git a/configuring-user-workload-monitoring/storing-and-recording-data-uwm.adoc b/configuring-user-workload-monitoring/storing-and-recording-data-uwm.adoc index 690076899217..1bbb36615883 100644 --- a/configuring-user-workload-monitoring/storing-and-recording-data-uwm.adoc +++ b/configuring-user-workload-monitoring/storing-and-recording-data-uwm.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] Store and record your metrics and alerting data, configure logs to specify which activities are recorded, control how long Prometheus retains stored data, and set the maximum amount of disk space for the data. These actions help you protect your data and use them for troubleshooting. // Configuring persistent storage diff --git a/getting-started/core-platform-monitoring-first-steps.adoc b/getting-started/core-platform-monitoring-first-steps.adoc index 29129df235d7..01c4dfd9fa7f 100644 --- a/getting-started/core-platform-monitoring-first-steps.adoc +++ b/getting-started/core-platform-monitoring-first-steps.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] After {ocp} is installed, core platform monitoring components immediately begin collecting metrics, which you can query and view. The default in-cluster monitoring stack includes the core platform Prometheus instance that collects metrics from your cluster and the core Alertmanager instance that routes alerts, among other components. Depending on who will use the monitoring stack and for what purposes, as a cluster administrator, you can further configure these monitoring components to suit the needs of different users in various scenarios. diff --git a/getting-started/developer-and-non-administrator-steps.adoc b/getting-started/developer-and-non-administrator-steps.adoc index 80904c0e0404..5927884d0d1a 100644 --- a/getting-started/developer-and-non-administrator-steps.adoc +++ b/getting-started/developer-and-non-administrator-steps.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] After monitoring for user-defined projects is enabled and configured, developers and other non-administrator users can then perform the following activities to set up and use monitoring for their own projects: * xref:../configuring-user-workload-monitoring/configuring-metrics-uwm.adoc#setting-up-metrics-collection-for-user-defined-projects_configuring-metrics-uwm[Deploy and monitor services]. diff --git a/getting-started/user-workload-monitoring-first-steps.adoc b/getting-started/user-workload-monitoring-first-steps.adoc index 1af0f26b41fc..42ad146f5c08 100644 --- a/getting-started/user-workload-monitoring-first-steps.adoc +++ b/getting-started/user-workload-monitoring-first-steps.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] As a cluster administrator, you can optionally enable monitoring for user-defined projects in addition to core platform monitoring. Non-administrator users such as developers can then monitor their own projects outside of core platform monitoring. diff --git a/key-concepts/key-concepts.adoc b/key-concepts/key-concepts.adoc index 1fc340035622..1c494a0ef891 100644 --- a/key-concepts/key-concepts.adoc +++ b/key-concepts/key-concepts.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] Get familiar with the {ocp} monitoring concepts and terms. Learn about how you can improve performance and scale of your cluster, store and record data, manage metrics and alerts, and more. [id="about-performance-and-scalability_{context}"] diff --git a/managing-alerts/managing-alerts-as-a-developer.adoc b/managing-alerts/managing-alerts-as-a-developer.adoc index ec7f0fc889d4..0e2b47a14a5c 100644 --- a/managing-alerts/managing-alerts-as-a-developer.adoc +++ b/managing-alerts/managing-alerts-as-a-developer.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] In {ocp}, the Alerting UI enables you to manage alerts, silences, and alerting rules. [NOTE] diff --git a/managing-alerts/managing-alerts-as-an-administrator.adoc b/managing-alerts/managing-alerts-as-an-administrator.adoc index 902834173ec6..5adca6a0bbb3 100644 --- a/managing-alerts/managing-alerts-as-an-administrator.adoc +++ b/managing-alerts/managing-alerts-as-an-administrator.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] In {ocp}, the Alerting UI enables you to manage alerts, silences, and alerting rules. [NOTE] diff --git a/release-notes/monitoring-release-notes.adoc b/release-notes/monitoring-release-notes.adoc index 6e4d2f63a041..3814ffb6a6f9 100644 --- a/release-notes/monitoring-release-notes.adoc +++ b/release-notes/monitoring-release-notes.adoc @@ -7,6 +7,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] The {ocp} release notes for the in-cluster monitoring stack contain information about new features and enhancements, Technology Previews, deprecated and removed features, known issues, and fixed issues. For details about other changes in the {ocp} release, see the link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html-single/release_notes/index#ocp-4-16-release-notes[{ocp} {product-version} release notes]. diff --git a/support-for-monitoring/maintenance-and-support-for-monitoring.adoc b/support-for-monitoring/maintenance-and-support-for-monitoring.adoc index 7707e864958c..de2e3686d20f 100644 --- a/support-for-monitoring/maintenance-and-support-for-monitoring.adoc +++ b/support-for-monitoring/maintenance-and-support-for-monitoring.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] Not all configuration options for the monitoring stack are exposed. The only supported way of configuring {ocp} monitoring is by configuring the {cmo-first} using the options described in the xref:../config-map-reference/config-map-reference-for-the-cluster-monitoring-operator.adoc#cluster-monitoring-operator-configuration-reference[Config map reference for the {cmo-full}]. *Do not use other configurations, as they are unsupported.* Configuration paradigms might change across Prometheus releases, and such cases can only be handled gracefully if all configuration possibilities are controlled. If you use configurations other than those described in the xref:../config-map-reference/config-map-reference-for-the-cluster-monitoring-operator.adoc#cluster-monitoring-operator-configuration-reference[Config map reference for the {cmo-full}], your changes will disappear because the {cmo-short} automatically reconciles any differences and resets any unsupported changes back to the originally defined state by default and by design. diff --git a/troubleshooting/troubleshooting-monitoring-issues.adoc b/troubleshooting/troubleshooting-monitoring-issues.adoc index 4320f07a744f..27b19d3c4600 100644 --- a/troubleshooting/troubleshooting-monitoring-issues.adoc +++ b/troubleshooting/troubleshooting-monitoring-issues.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] ifndef::openshift-dedicated,openshift-rosa[] Find troubleshooting steps for common issues with core platform and user-defined project monitoring. endif::openshift-dedicated,openshift-rosa[]