From dd459b58a381b62b24b5bf0e83095f0d90e3420c 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 Cherry-picking commit 34205d3ee1. modified: _attributes/common-attributes.adoc modified: _topic_maps/_topic_map.yml new file: observability/_attributes new file: observability/hugeBook.flag new file: observability/images new file: observability/index.adoc new file: observability/modules new file: observability/snippets --- _attributes/common-attributes.adoc | 3 ++ _topic_maps/_topic_map.yml | 7 ++++ observability/_attributes | 1 + observability/hugeBook.flag | 0 observability/images | 1 + observability/index.adoc | 56 ++++++++++++++++++++++++++++++ observability/modules | 1 + observability/snippets | 1 + 8 files changed, 70 insertions(+) create mode 120000 observability/_attributes create mode 100644 observability/hugeBook.flag create mode 120000 observability/images create mode 100644 observability/index.adoc create mode 120000 observability/modules create mode 120000 observability/snippets diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc index 2c041b0b4009..57f3682c59ff 100644 --- a/_attributes/common-attributes.adoc +++ b/_attributes/common-attributes.adoc @@ -145,6 +145,9 @@ endif::[] :loki-op: Loki Operator :es-op: OpenShift Elasticsearch Operator :log-plug: logging Console plugin +//observability +:ObservabilityLongName: Red Hat OpenShift Observability +:ObservabilityShortName: Observability //serverless :ServerlessProductName: OpenShift Serverless :ServerlessProductShortName: Serverless diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 6ef3d492fddf..c1bff29d5f76 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -2480,6 +2480,13 @@ 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: Logging Dir: logging Distros: openshift-enterprise,openshift-origin diff --git a/observability/_attributes b/observability/_attributes new file mode 120000 index 000000000000..f27fd275ea6b --- /dev/null +++ b/observability/_attributes @@ -0,0 +1 @@ +../_attributes/ \ No newline at end of file diff --git a/observability/hugeBook.flag b/observability/hugeBook.flag new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/observability/images b/observability/images new file mode 120000 index 000000000000..e4c5bd02a10a --- /dev/null +++ b/observability/images @@ -0,0 +1 @@ +../images/ \ No newline at end of file diff --git a/observability/index.adoc b/observability/index.adoc new file mode 100644 index 000000000000..401afefe13f5 --- /dev/null +++ b/observability/index.adoc @@ -0,0 +1,56 @@ +:_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 + +{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#distr-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-installing.adoc#install-otel[Red Hat build of OpenTelemetry]. +//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]. + diff --git a/observability/modules b/observability/modules new file mode 120000 index 000000000000..43aab75b53c9 --- /dev/null +++ b/observability/modules @@ -0,0 +1 @@ +../modules/ \ No newline at end of file diff --git a/observability/snippets b/observability/snippets new file mode 120000 index 000000000000..9f5bc7e4dde0 --- /dev/null +++ b/observability/snippets @@ -0,0 +1 @@ +../snippets \ No newline at end of file