From 6c07ffe6be424f509d39cc49d3343db81d6729c2 Mon Sep 17 00:00:00 2001 From: linfraze Date: Tue, 6 Feb 2024 09:09:12 -0500 Subject: [PATCH] OBSDOCS-689: add observability dir and update topic map rh-pre-commit.version: 2.2.0 rh-pre-commit.check-secrets: ENABLED --- _attributes/common-attributes.adoc | 3 + _topic_maps/_topic_map.yml | 40 +++++++----- .../_attributes | 0 observability/hugeBook.flag | 0 {power_monitoring => observability}/images | 0 observability/index.adoc | 62 +++++++++++++++++++ {power_monitoring => observability}/modules | 0 observability/power_monitoring/_attributes | 1 + .../configuring-power-monitoring.adoc | 0 observability/power_monitoring/images | 1 + .../installing-power-monitoring.adoc | 0 observability/power_monitoring/modules | 1 + .../power-monitoring-overview.adoc | 0 .../power-monitoring-release-notes.adoc | 0 .../power_monitoring}/snippets | 0 .../uninstalling-power-monitoring.adoc | 0 .../visualizing-power-monitoring-metrics.adoc | 3 +- observability/snippets | 1 + welcome/index.adoc | 2 +- 19 files changed, 95 insertions(+), 19 deletions(-) rename {power_monitoring => observability}/_attributes (100%) create mode 100644 observability/hugeBook.flag rename {power_monitoring => observability}/images (100%) create mode 100644 observability/index.adoc rename {power_monitoring => observability}/modules (100%) create mode 120000 observability/power_monitoring/_attributes rename {power_monitoring => observability/power_monitoring}/configuring-power-monitoring.adoc (100%) create mode 120000 observability/power_monitoring/images rename {power_monitoring => observability/power_monitoring}/installing-power-monitoring.adoc (100%) create mode 120000 observability/power_monitoring/modules rename {power_monitoring => observability/power_monitoring}/power-monitoring-overview.adoc (100%) rename {power_monitoring => observability/power_monitoring}/power-monitoring-release-notes.adoc (100%) rename {power_monitoring => observability/power_monitoring}/snippets (100%) rename {power_monitoring => observability/power_monitoring}/uninstalling-power-monitoring.adoc (100%) rename {power_monitoring => observability/power_monitoring}/visualizing-power-monitoring-metrics.adoc (63%) create mode 120000 observability/snippets diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc index 2ed0786efd..18c78e6ae5 100644 --- a/_attributes/common-attributes.adoc +++ b/_attributes/common-attributes.adoc @@ -147,6 +147,9 @@ endif::[] :loki-op: Loki Operator :es-op: OpenShift Elasticsearch Operator :log-plug: logging Console plugin +//observability +:ObservabilityLongName: Red Hat OpenShift Observability +:ObservabilityShortName: Observability //power monitoring :PM-title-c: Power monitoring for Red Hat OpenShift :PM-title: power monitoring for Red Hat OpenShift diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index c6efbae8ff..5f87953402 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -2591,6 +2591,29 @@ Topics: - Name: OpenShift sandboxed containers documentation has been moved File: sandboxed-containers-moved --- +Name: Observability +Dir: observability +Distros: openshift-enterprise,openshift-origin +Topics: +- Name: Observability overview + File: index +- Name: Power Monitoring + Dir: power_monitoring + Distros: openshift-enterprise,openshift-origin + Topics: + - Name: Power monitoring release notes + File: power-monitoring-release-notes + - Name: Power monitoring overview + File: power-monitoring-overview + - Name: Installing power monitoring + File: installing-power-monitoring + - Name: Configuring power monitoring + File: configuring-power-monitoring + - Name: Visualizing power monitoring metrics + File: visualizing-power-monitoring-metrics + - Name: Uninstalling power monitoring + File: uninstalling-power-monitoring +--- Name: Logging Dir: logging Distros: openshift-enterprise,openshift-origin @@ -2739,23 +2762,6 @@ Topics: - Name: Configuring the Cluster Observability Operator to monitor a service File: configuring-the-cluster-observability-operator-to-monitor-a-service --- -Name: Power monitoring -Dir: power_monitoring -Distros: openshift-enterprise,openshift-origin -Topics: -- Name: Power monitoring release notes - File: power-monitoring-release-notes -- Name: Power monitoring overview - File: power-monitoring-overview -- Name: Installing power monitoring - File: installing-power-monitoring -- Name: Configuring power monitoring - File: configuring-power-monitoring -- Name: Visualizing power monitoring metrics - File: visualizing-power-monitoring-metrics -- Name: Uninstalling power monitoring - File: uninstalling-power-monitoring ---- Name: Distributed tracing Dir: distr_tracing Distros: openshift-enterprise diff --git a/power_monitoring/_attributes b/observability/_attributes similarity index 100% rename from power_monitoring/_attributes rename to observability/_attributes diff --git a/observability/hugeBook.flag b/observability/hugeBook.flag new file mode 100644 index 0000000000..e69de29bb2 diff --git a/power_monitoring/images b/observability/images similarity index 100% rename from power_monitoring/images rename to observability/images diff --git a/observability/index.adoc b/observability/index.adoc new file mode 100644 index 0000000000..f7b2a37b42 --- /dev/null +++ b/observability/index.adoc @@ -0,0 +1,62 @@ +:_mod-docs-content-type: ASSEMBLY +[id="observability-overview"] += {product-title} Observability overview +include::_attributes/common-attributes.adoc[] +:context: observability-overview + +toc::[] + + +{ObservabilityLongName} provides real-time visibility, monitoring, and analysis of various system metrics, logs, traces, and events to help users quickly diagnose and troubleshoot issues before they impact systems or applications. To help ensure the reliability, performance, and security of your applications and infrastructure, {product-title} offers the following {ObservabilityShortName} components: + +* Monitoring +* {logging-uc} +* Distributed tracing +* {OTELName} +* Network Observability +* {PM-shortname-c} + +{ObservabilityLongName} connects open source observability tools and technologies to create a unified {ObservabilityShortName} solution. The components of {ObservabilityLongName} work together to help you collect, store, deliver, analyze, and visualize data. + +[id="monitoring-overview-index"] +== Monitoring +Monitor the in-cluster health and performance of your applications running on {product-title} with metrics and customized alerts for CPU and memory usage, network connectivity, and other resource usage. Monitoring stack components are deployed and managed by the Cluster Monitoring Operator. + +Monitoring stack components are deployed by default in every {product-title} installation and are managed by the Cluster Monitoring Operator (CMO). These components include Prometheus, Alertmanager, Thanos Querier, and others. The CMO also deploys the Telemeter Client, which sends a subset of data from platform Prometheus instances to Red Hat to facilitate Remote Health Monitoring for clusters. + +For more information, see xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] and xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring]. +//after the file is added to the observability directory, update xref path to ../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]. + +[id="cluster-logging-index"] +== Logging +Collect, visualize, forward, and store log data to troubleshoot issues, identify performance bottlenecks, and detect security threats. In logging 5.7 and later versions, users can configure the LokiStack deployment to produce customized alerts and recorded metrics. + +For more information, see xref:../logging/cluster-logging.adoc#cluster-logging[About Logging]. +//after the file is added to the observability directory, update xref path to ../observability/logging/cluster-logging.adoc#cluster-logging[About Logging]. + +[id="distr-tracing-architecture-index"] +== Distributed tracing +Store and visualize large volumes of requests passing through distributed systems, across the whole stack of microservices, and under heavy loads. Use it for monitoring distributed transactions, gathering insights into your instrumented services, network profiling, performance and latency optimization, root cause analysis, and troubleshooting the interaction between components in modern cloud-native microservices-based applications. + +For more information, see xref:../distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distributed-tracing-architecture[Distributed tracing architecture]. +//after the file is added to the observability directory, update xref path to ../observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distributed-tracing-architecture[Distributed tracing architecture]. + +[id="otel-release-notes-index"] +== {OTELName} +Instrument, generate, collect, and export telemetry traces, metrics, and logs to analyze and understand your software's performance and behavior. Use open source backends like Tempo or Prometheus, or use commercial offerings. Learn a single set of APIs and conventions, and own the data that you generate. + +For more information, see xref:../otel/otel-release-notes.adoc#otel-release-notes[{OTELName} release notes]. +//after the file is added to the observability directory, update xref path to ../observability/otel/otel-release-notes.adoc#otel-release-notes[{OTELName} release notes]. + +[id="network-observability-overview-index"] +== Network Observability +Observe the network traffic for {product-title} clusters and create network flows with the Network Observability Operator. View and analyze the stored network flows information in the {product-title} console for further insight and troubleshooting. + +For more information, see xref:../network_observability/network-observability-overview.adoc#network-observability-overview[Network Observability overview]. +//after the file is added to the observability directory, update xref path to ../observability/network_observability/network-observability-overview.adoc#network-observability-overview[Network Observability overview]. + +[id="power-monitoring-overview-index"] +== Power monitoring +Monitor the power usage of workloads and identify the most power-consuming namespaces running in a cluster with key power consumption metrics, such as CPU or DRAM measured at container level. Visualize energy-related system statistics with the {PM-operator}. + +For more information, see xref:../observability/power_monitoring/power-monitoring-overview.adoc#power-monitoring-overview[Power Monitoring overview]. diff --git a/power_monitoring/modules b/observability/modules similarity index 100% rename from power_monitoring/modules rename to observability/modules diff --git a/observability/power_monitoring/_attributes b/observability/power_monitoring/_attributes new file mode 120000 index 0000000000..f27fd275ea --- /dev/null +++ b/observability/power_monitoring/_attributes @@ -0,0 +1 @@ +../_attributes/ \ No newline at end of file diff --git a/power_monitoring/configuring-power-monitoring.adoc b/observability/power_monitoring/configuring-power-monitoring.adoc similarity index 100% rename from power_monitoring/configuring-power-monitoring.adoc rename to observability/power_monitoring/configuring-power-monitoring.adoc diff --git a/observability/power_monitoring/images b/observability/power_monitoring/images new file mode 120000 index 0000000000..e4c5bd02a1 --- /dev/null +++ b/observability/power_monitoring/images @@ -0,0 +1 @@ +../images/ \ No newline at end of file diff --git a/power_monitoring/installing-power-monitoring.adoc b/observability/power_monitoring/installing-power-monitoring.adoc similarity index 100% rename from power_monitoring/installing-power-monitoring.adoc rename to observability/power_monitoring/installing-power-monitoring.adoc diff --git a/observability/power_monitoring/modules b/observability/power_monitoring/modules new file mode 120000 index 0000000000..43aab75b53 --- /dev/null +++ b/observability/power_monitoring/modules @@ -0,0 +1 @@ +../modules/ \ No newline at end of file diff --git a/power_monitoring/power-monitoring-overview.adoc b/observability/power_monitoring/power-monitoring-overview.adoc similarity index 100% rename from power_monitoring/power-monitoring-overview.adoc rename to observability/power_monitoring/power-monitoring-overview.adoc diff --git a/power_monitoring/power-monitoring-release-notes.adoc b/observability/power_monitoring/power-monitoring-release-notes.adoc similarity index 100% rename from power_monitoring/power-monitoring-release-notes.adoc rename to observability/power_monitoring/power-monitoring-release-notes.adoc diff --git a/power_monitoring/snippets b/observability/power_monitoring/snippets similarity index 100% rename from power_monitoring/snippets rename to observability/power_monitoring/snippets diff --git a/power_monitoring/uninstalling-power-monitoring.adoc b/observability/power_monitoring/uninstalling-power-monitoring.adoc similarity index 100% rename from power_monitoring/uninstalling-power-monitoring.adoc rename to observability/power_monitoring/uninstalling-power-monitoring.adoc diff --git a/power_monitoring/visualizing-power-monitoring-metrics.adoc b/observability/power_monitoring/visualizing-power-monitoring-metrics.adoc similarity index 63% rename from power_monitoring/visualizing-power-monitoring-metrics.adoc rename to observability/power_monitoring/visualizing-power-monitoring-metrics.adoc index fc89d7c762..15d69d0a46 100644 --- a/power_monitoring/visualizing-power-monitoring-metrics.adoc +++ b/observability/power_monitoring/visualizing-power-monitoring-metrics.adoc @@ -18,5 +18,6 @@ include::modules/power-monitoring-metrics-overview.adoc[leveloffset=+1] [role="_additional-resources"] [id="additional-resources_visualizing-power-monitoring-metrics"] == Additional resources -* xref:../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects_enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects] +* xref:../../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects_enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects] +//after the file is added to the observability directory, update xref path to ../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects_enabling-monitoring-for-user-defined-projects diff --git a/observability/snippets b/observability/snippets new file mode 120000 index 0000000000..9f5bc7e4dd --- /dev/null +++ b/observability/snippets @@ -0,0 +1 @@ +../snippets \ No newline at end of file diff --git a/welcome/index.adoc b/welcome/index.adoc index f44e4e4cc2..06faa1e142 100644 --- a/welcome/index.adoc +++ b/welcome/index.adoc @@ -309,7 +309,7 @@ After configuring monitoring, use the web console to access xref:../monitoring/r - **xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring_about-remote-health-monitoring[Remote health monitoring]**: {product-title} collects anonymized aggregated information about your cluster. By using Telemetry and the Insights Operator, this data is received by Red Hat and used to improve {product-title}. You can view the xref:../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#showing-data-collected-by-remote-health-monitoring_showing-data-collected-by-remote-health-monitoring[data collected by remote health monitoring]. -- **xref:../power_monitoring/power-monitoring-overview.adoc#power-monitoring-overview[{PM-title-c} (Technology Preview)]**: You can use {PM-title} to monitor the power usage and identify power-consuming containers running in an {product-title} cluster. {PM-shortname-c} collects and exports energy-related system statistics from various components, such as CPU and DRAM. {PM-shortname-c} provides granular power consumption data for Kubernetes pods, namespaces, and nodes. +- **xref:../observability/power_monitoring/power-monitoring-overview.adoc#power-monitoring-overview[{PM-title-c} (Technology Preview)]**: You can use {PM-title} to monitor the power usage and identify power-consuming containers running in an {product-title} cluster. {PM-shortname-c} collects and exports energy-related system statistics from various components, such as CPU and DRAM. {PM-shortname-c} provides granular power consumption data for Kubernetes pods, namespaces, and nodes. endif::openshift-enterprise,openshift-webscale,openshift-origin[] ifdef::openshift-dedicated[]