Monitoring overview

Amrita · Amrita · commit aea93698433f · 2022-02-07T21:48:08.000+05:30
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -1997,8 +1997,8 @@ Name: Monitoring
 Dir: monitoring
 Distros: openshift-enterprise,openshift-origin
 Topics:
-- Name: Understanding the monitoring stack
-  File: understanding-the-monitoring-stack
+- Name: Monitoring overview
+  File: monitoring-overview
 - Name: Configuring the monitoring stack
   File: configuring-the-monitoring-stack
 - Name: Enabling monitoring for user-defined projects
diff --git a/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc b/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc
@@ -19,4 +19,4 @@ include::modules/odc-monitoring-your-project-metrics.adoc[leveloffset=+1]
 include::modules/odc-monitoring-your-application-metrics.adoc[leveloffset=+1]
 
 == Additional Resources
-* xref:../monitoring/understanding-the-monitoring-stack.adoc#understanding-the-monitoring-stack[Understanding the monitoring stack]
+* xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
diff --git a/installing/installing_vsphere/using-vsphere-problem-detector-operator.adoc b/installing/installing_vsphere/using-vsphere-problem-detector-operator.adoc
@@ -29,4 +29,4 @@ include::modules/vsphere-problem-detector-metrics.adoc[leveloffset=+1]
 
 == Additional resources
 
-* xref:../../monitoring/understanding-the-monitoring-stack.adoc[Understanding the monitoring stack]
+* xref:../../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
diff --git a/installing/validating-an-installation.adoc b/installing/validating-an-installation.adoc
@@ -49,7 +49,7 @@ include::modules/checking-cluster-resource-availability-and-utilization.adoc[lev
 
 .Additional resources
 
-* See xref:../monitoring/understanding-the-monitoring-stack.adoc#understanding-the-monitoring-stack[Understanding the monitoring stack] for more information about the {product-title} monitoring stack.
+* See xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] for more information about the {product-title} monitoring stack.
 
 //Listing alerts that are firing
 include::modules/listing-alerts-that-are-firing.adoc[leveloffset=+1]
diff --git a/logging/cluster-logging-dashboards.adoc b/logging/cluster-logging-dashboards.adoc
@@ -10,11 +10,11 @@ The *Logging/Elasticsearch Nodes* and *Openshift Logging* dashboards in the {pro
 
 The *OpenShift Logging* dashboard contains charts that show details about your Elasticsearch instance at a cluster level, including cluster resources, garbage collection, shards in the cluster, and Fluentd statistics.
 
-The *Logging/Elasticsearch Nodes* dashboard contains charts that show details about your Elasticsearch instance, many at node level, including details on indexing, shards, resources, and so forth. 
+The *Logging/Elasticsearch Nodes* dashboard contains charts that show details about your Elasticsearch instance, many at node level, including details on indexing, shards, resources, and so forth.
 
 [NOTE]
 ====
-For more detailed data, click the *Grafana UI* link in a dashboard to launch the Grafana dashboard. Grafana is shipped with xref:../monitoring/understanding-the-monitoring-stack.adoc#understanding-the-monitoring-stack[OpenShift cluster monitoring].
+For more detailed data, click the *Grafana UI* link in a dashboard to launch the Grafana dashboard. Grafana is shipped with xref:../monitoring/monitoring-overview.adoc#monitoring-overview[OpenShift cluster monitoring].
 ====
 
 // The following include statements pull in the module files that comprise
@@ -24,8 +24,7 @@ For more detailed data, click the *Grafana UI* link in a dashboard to launch the
 
 include::modules/cluster-logging-dashboards-access.adoc[leveloffset=+1]
 
-For information on the dashboard charts, see xref:../logging/cluster-logging-dashboards.html#cluster-logging-dashboards-logging_cluster-logging-dashboards[About the OpenShift Logging dashboard] and xref:../logging/cluster-logging-dashboards.html#cluster-logging-dashboards-es_cluster-logging-dashboards[About the Logging/Elastisearch Nodes dashboard]. 
+For information on the dashboard charts, see xref:../logging/cluster-logging-dashboards.html#cluster-logging-dashboards-logging_cluster-logging-dashboards[About the OpenShift Logging dashboard] and xref:../logging/cluster-logging-dashboards.html#cluster-logging-dashboards-es_cluster-logging-dashboards[About the Logging/Elastisearch Nodes dashboard].
 
 include::modules/cluster-logging-dashboards-logging.adoc[leveloffset=+1]
 include::modules/cluster-logging-dashboards-es.adoc[leveloffset=+1]
-
diff --git a/modules/monitoring-about-cluster-monitoring.adoc b/modules/monitoring-about-cluster-monitoring.adoc
@@ -1,7 +1,7 @@
 // Module included in the following assemblies:
 //
 // * virt/logging_events_monitoring/virt-openshift-cluster-monitoring.adoc
-// * monitoring/understanding-the-monitoring-stack.adoc
+// * monitoring/monitoring-overview.adoc
 
 // This module uses a conditionalized title so that the module
 // can be re-used in associated products but the title is not
diff --git a/modules/monitoring-components-for-monitoring-user-defined-projects.adoc b/modules/monitoring-components-for-monitoring-user-defined-projects.adoc
@@ -1,7 +1,8 @@
 // Module included in the following assemblies:
 //
-// * monitoring/understanding-the-monitoring-stack.adoc
+// * monitoring/monitoring-overview.adoc
 
+:_content-type: REFERENCE
 [id="components-for-monitoring-user-defined-projects_{context}"]
 = Components for monitoring user-defined projects
 
diff --git a/modules/monitoring-default-monitoring-components.adoc b/modules/monitoring-default-monitoring-components.adoc
@@ -1,7 +1,8 @@
 // Module included in the following assemblies:
 //
-// * monitoring/understanding-the-monitoring-stack.adoc
+// * monitoring/monitoring-overview.adoc
 
+:_content-type: REFERENCE
 [id="default-monitoring-components_{context}"]
 = Default monitoring components
 
@@ -53,5 +54,5 @@ All of the components in the monitoring stack are monitored by the stack and are
 [NOTE]
 ====
 All components of the monitoring stack use the TLS security profile settings that are centrally configured by a cluster administrator.
-If you configure a monitoring stack component that uses TLS security settings, the component uses the TLS security profile settings that already exist in the `tlsSecurityProfile` field in the global {product-title} `apiservers.config.openshift.io/cluster` resource. 
+If you configure a monitoring stack component that uses TLS security settings, the component uses the TLS security profile settings that already exist in the `tlsSecurityProfile` field in the global {product-title} `apiservers.config.openshift.io/cluster` resource.
 ====
diff --git a/modules/monitoring-default-monitoring-targets.adoc b/modules/monitoring-default-monitoring-targets.adoc
@@ -1,7 +1,8 @@
 // Module included in the following assemblies:
 //
-// * monitoring/understanding-the-monitoring-stack.adoc
+// * monitoring/monitoring-overview.adoc
 
+:_content-type: REFERENCE
 [id="default-monitoring-targets_{context}"]
 = Default monitoring targets
 
diff --git a/modules/monitoring-targets-for-user-defined-projects.adoc b/modules/monitoring-targets-for-user-defined-projects.adoc
@@ -1,7 +1,8 @@
 // Module included in the following assemblies:
 //
-// * monitoring/understanding-the-monitoring-stack.adoc
+// * monitoring/monitoring-overview.adoc
 
+:_content-type: CONCEPT
 [id="monitoring-targets-for-user-defined-projects_{context}"]
 = Monitoring targets for user-defined projects
 
diff --git a/modules/monitoring-understanding-the-monitoring-stack.adoc b/modules/monitoring-understanding-the-monitoring-stack.adoc
@@ -1,7 +1,7 @@
 // Module included in the following assemblies:
 //
 // * virt/logging_events_monitoring/virt-openshift-cluster-monitoring.adoc
-// * monitoring/understanding-the-monitoring-stack.adoc
+// * monitoring/monitoring-overview.adoc
 
 // This module uses a conditionalized title so that the module
 // can be re-used in associated products but the title is not
diff --git a/monitoring/managing-alerts.adoc b/monitoring/managing-alerts.adoc
@@ -33,12 +33,12 @@ include::modules/monitoring-optimizing-alerting-for-user-defined-projects.adoc[l
 .Additional resources
 
 * See the link:https://prometheus.io/docs/practices/alerting/[Prometheus alerting documentation] for further guidelines on optimizing alerts
-* See xref:../monitoring/understanding-the-monitoring-stack.adoc#understanding-the-monitoring-stack[Understanding the monitoring stack] for details about {product-title} {product-version} monitoring architecture
+* See xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] for details about {product-title} {product-version} monitoring architecture
 
 include::modules/monitoring-creating-alerting-rules-for-user-defined-projects.adoc[leveloffset=+2]
 include::modules/monitoring-reducing-latency-for-alerting-rules-that-do-not-query-platform-metrics.adoc[leveloffset=+2]
 
-* See xref:../monitoring/understanding-the-monitoring-stack.adoc#understanding-the-monitoring-stack[Understanding the monitoring stack] for details about {product-title} {product-version} monitoring architecture.
+* See xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] for details about {product-title} {product-version} monitoring architecture.
 
 include::modules/monitoring-accessing-alerting-rules-for-your-project.adoc[leveloffset=+2]
 include::modules/monitoring-listing-alerting-rules-for-all-projects-in-a-single-view.adoc[leveloffset=+2]
diff --git a/monitoring/monitoring-overview.adoc b/monitoring/monitoring-overview.adoc
@@ -0,0 +1,38 @@
+:_content-type: ASSEMBLY
+[id="monitoring-overview"]
+= Monitoring overview
+include::modules/common-attributes.adoc[]
+:context: monitoring-overview
+
+toc::[]
+
+[id="about-openshift-monitoring"]
+== About {product-title} monitoring
+
+{product-title} includes a preconfigured, preinstalled, and self-updating monitoring stack that provides monitoring for core platform components. You also have the option to xref:../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[enable monitoring for user-defined projects].
+
+A cluster administrator can xref:../monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[configure the monitoring stack] with the supported configurations. {product-title} delivers monitoring best practices out of the box.
+
+A set of alerts are included by default that immediately notify cluster administrators about issues with a cluster. Default dashboards in the {product-title} web console include visual representations of cluster metrics to help you to quickly understand the state of your cluster.
+
+The {product-title} web console provides xref:../monitoring/accessing-third-party-uis.adoc#accessing-third-party-uis[third-party integrated UIs] such as xref:../monitoring/managing-metrics.adoc#managing-metrics[metrics], xref:../monitoring/managing-alerts.adoc#managing-alerts[alerts], and xref:../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[review of monitoring dashboards]. You can access these third-party user interfaces (UIs) either through the web console or the CLI.
+
+After installing {product-title} {product-version}, cluster administrators can optionally enable monitoring for user-defined projects. By using this feature, cluster administrators, developers, and other users can specify how services and pods are monitored in their own projects. 
+As a cluster administrator, you can find answers to common problems such as user metrics unavailability and Prometheus consuming a lot of disk space in xref:../monitoring/troubleshooting-monitoring-issues.adoc#troubleshooting-monitoring-issues[troubleshooting monitoring issues].
+
+// Understanding the monitoring stack
+include::modules/monitoring-understanding-the-monitoring-stack.adoc[leveloffset=+1]
+include::modules/monitoring-default-monitoring-components.adoc[leveloffset=+2]
+include::modules/monitoring-default-monitoring-targets.adoc[leveloffset=+2]
+include::modules/monitoring-components-for-monitoring-user-defined-projects.adoc[leveloffset=+2]
+include::modules/monitoring-targets-for-user-defined-projects.adoc[leveloffset=+2]
+
+== Additional resources
+
+* xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring]
+* xref:../monitoring/enabling-monitoring-for-user-defined-projects.adoc#granting-users-permission-to-monitor-user-defined-projects_enabling-monitoring-for-user-defined-projects[Granting users permission to monitor user-defined projects]
+* xref:../security/tls-security-profiles.adoc#tls-security-profiles[Configuring TLS security profiles]
+
+== Next steps
+
+* xref:../monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[Configuring the monitoring stack]
diff --git a/monitoring/understanding-the-monitoring-stack.adoc b/monitoring/understanding-the-monitoring-stack.adoc
diff --git a/nodes/nodes/nodes-nodes-machine-config-daemon-metrics.adoc b/nodes/nodes/nodes-nodes-machine-config-daemon-metrics.adoc
@@ -10,5 +10,5 @@ include::modules/machine-config-daemon-metrics.adoc[leveloffset=+1]
 
 .Additional resources
 
-* See xref:../../monitoring/understanding-the-monitoring-stack.adoc#understanding-the-monitoring-stack[the documentation on the {product-title} monitoring stack].
+* See xref:../../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview].
 * See xref:../../support/gathering-cluster-data.adoc[the documentation on gathering data about your cluster].
diff --git a/post_installation_configuration/configuring-alert-notifications.adoc b/post_installation_configuration/configuring-alert-notifications.adoc
@@ -14,5 +14,5 @@ include::modules/monitoring-configuring-alert-receivers.adoc[leveloffset=+2]
 [id="configuring-alert-notifications-additional-resources"]
 == Additional resources
 
-* xref:../monitoring/understanding-the-monitoring-stack.adoc#understanding-the-monitoring-stack[Understanding the monitoring stack]
+* xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
 * xref:../monitoring/managing-alerts.adoc#managing-alerts[Managing alerts]
diff --git a/serverless/monitor/serverless-service-monitoring.adoc b/serverless/monitor/serverless-service-monitoring.adoc
@@ -21,7 +21,7 @@ Scraping the metrics does not affect autoscaling of a Knative service, because s
 
 .Additional resources
 
-* For more information on {product-title} monitoring stack, see xref:../../monitoring/understanding-the-monitoring-stack.adoc#understanding-the-monitoring-stack[Understanding the monitoring stack].
+* For more information on {product-title} monitoring stack, see xref:../../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview].
 
 * For information on monitoring the components of Serverless itself, as opposed to Knative services, see xref:../../serverless/admin_guide/serverless-admin-monitoring.adoc#serverless-admin-monitoring[Monitoring serverless components].
 
diff --git a/support/remote_health_monitoring/about-remote-health-monitoring.adoc b/support/remote_health_monitoring/about-remote-health-monitoring.adoc
@@ -82,7 +82,7 @@ include::modules/understanding-telemetry-and-insights-operator-data-flow.adoc[le
 ifndef::openshift-dedicated[]
 .Additional resources
 
-* See xref:../../monitoring/understanding-the-monitoring-stack.adoc#understanding-the-monitoring-stack_understanding-the-monitoring-stack[Understanding the monitoring stack] for more information about the {product-title} monitoring stack.
+* See xref:../../monitoring/monitoring-overview.adoc#monitoring-overview_monitoring-overview[Monitoring overview] for more information about the {product-title} monitoring stack.
 
 * See xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[Configuring your firewall] for details about configuring a firewall and enabling endpoints for Telemetry and Insights
 endif::[]
diff --git a/virt/install/preparing-cluster-for-virt.adoc b/virt/install/preparing-cluster-for-virt.adoc
@@ -63,7 +63,7 @@ Without an external monitoring system or a qualified human monitoring node healt
 
 {VirtProductName} works with {product-title} by default, but the following installation configurations are recommended:
 
-* Configure xref:../../monitoring/understanding-the-monitoring-stack.adoc#understanding-the-monitoring-stack[monitoring] in the cluster.
+* Configure xref:../../monitoring/monitoring-overview.adoc#monitoring-overview[monitoring] in the cluster.
 
 [NOTE]
 ====
diff --git a/virt/logging_events_monitoring/virt-prometheus-queries.adoc b/virt/logging_events_monitoring/virt-prometheus-queries.adoc
@@ -33,4 +33,4 @@ include::modules/virt-querying-metrics.adoc[leveloffset=+1]
 [id="additional-resources_virt-prometheus-queries"]
 == Additional resources
 
-* xref:../../monitoring/understanding-the-monitoring-stack.adoc#understanding-the-monitoring-stack[Understanding the {product-title} monitoring stack]
+* xref:../../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
diff --git a/virt/logging_events_monitoring/virt-reviewing-virtualization-overview.adoc b/virt/logging_events_monitoring/virt-reviewing-virtualization-overview.adoc
@@ -24,7 +24,7 @@ include::modules/virt-reviewing-top-consumers-projects-vms-nodes.adoc[leveloffse
 [id="additional-resources_reviewing-virtualization-overview"]
 == Additional resources
 
-* xref:../../monitoring/understanding-the-monitoring-stack.adoc#understanding-the-monitoring-stack[Understanding the {product-title} monitoring stack]
+* xref:../../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
 
 * xref:../../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[Reviewing monitoring dashboards]
 
diff --git a/virt/logging_events_monitoring/virt-reviewing-vm-dashboard.adoc b/virt/logging_events_monitoring/virt-reviewing-vm-dashboard.adoc
@@ -6,7 +6,7 @@ include::modules/virt-document-attributes.adoc[]
 
 toc::[]
 
-Dashboards in the {product-title} web console provide visual representations of cluster metrics to help you to quickly understand the state of your cluster. Dashboards belong to the xref:../../monitoring/understanding-the-monitoring-stack.adoc#understanding-the-monitoring-stack[monitoring stack] that provides monitoring for core platform components.
+Dashboards in the {product-title} web console provide visual representations of cluster metrics to help you to quickly understand the state of your cluster. Dashboards belong to the xref:../../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] that provides monitoring for core platform components.
 
 The {VirtProductName} dashboard provides data on resource consumption for virtual machines and associated pods. The visualization metrics displayed in the {VirtProductName} dashboard are based on xref:../../virt/logging_events_monitoring/virt-prometheus-queries.adoc#virt-prometheus-queries[Prometheus Query Language (PromQL) queries].
 
@@ -19,6 +19,6 @@ include::modules/virt-reviewing-top-consumers.adoc[leveloffset=+1]
 [id="additional-resources_reviewing-vm-dashboard"]
 == Additional resources
 
-* xref:../../monitoring/understanding-the-monitoring-stack.adoc#understanding-the-monitoring-stack[Understanding the {product-title} monitoring stack]
+* xref:../../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
 
 * xref:../../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[Reviewing monitoring dashboards]
diff --git a/welcome/index.adoc b/welcome/index.adoc
@@ -282,7 +282,7 @@ xref:../updating/updating-disconnected-cluster.adoc#updating-disconnected-cluste
 
 - **xref:../logging/cluster-logging.adoc#cluster-logging[Work with OpenShift Logging]**: Learn about OpenShift Logging and configure different OpenShift Logging types, such as Elasticsearch, Fluentd, and Kibana.
 
-- **xref:../monitoring/understanding-the-monitoring-stack.adoc#understanding-the-monitoring-stack[Monitor clusters]**:
+- **xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitor]**:
 Learn to  xref:../monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[configure the monitoring stack].
 After configuring monitoring, use the web console to access xref:../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[monitoring dashboards]. In addition to infrastructure metrics, you can also scrape and view metrics for your own services.
 
diff --git a/welcome/learn_more_about_openshift.adoc b/welcome/learn_more_about_openshift.adoc

Original file line number	Diff line number	Diff line change
`@@ -29,4 +29,4 @@ include::modules/vsphere-problem-detector-metrics.adoc[leveloffset=+1]`
`29`	`29`
`30`	`30`	`== Additional resources`
`31`	`31`
`32`		`-* xref:../../monitoring/understanding-the-monitoring-stack.adoc[Understanding the monitoring stack]`
	`32`	`+* xref:../../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]`