1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

OBSDOCS-689: add observability dir and update topic map

rh-pre-commit.version: 2.2.0
rh-pre-commit.check-secrets: ENABLED
This commit is contained in:
linfraze
2024-02-06 09:09:12 -05:00
committed by openshift-cherrypick-robot
parent 38ca6733ef
commit 6c07ffe6be
19 changed files with 95 additions and 19 deletions

View File

@@ -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

View File

@@ -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

View File

62
observability/index.adoc Normal file
View File

@@ -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].

View File

@@ -0,0 +1 @@
../_attributes/

View File

@@ -0,0 +1 @@
../images/

View File

@@ -0,0 +1 @@
../modules/

View File

@@ -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

1
observability/snippets Symbolic link
View File

@@ -0,0 +1 @@
../snippets

View File

@@ -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[]