Skip to content

Commit 0eee57e

Browse files
authored
Merge pull request #71248 from linfraze/OBSDOCS-689
OBSDOCS-689: add observability dir and update topic map
2 parents 2f386d6 + 34205d3 commit 0eee57e

19 files changed

+95
-19
lines changed

_attributes/common-attributes.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,9 @@ endif::[]
147147
:loki-op: Loki Operator
148148
:es-op: OpenShift Elasticsearch Operator
149149
:log-plug: logging Console plugin
150+
//observability
151+
:ObservabilityLongName: Red Hat OpenShift Observability
152+
:ObservabilityShortName: Observability
150153
//power monitoring
151154
:PM-title-c: Power monitoring for Red Hat OpenShift
152155
:PM-title: power monitoring for Red Hat OpenShift

_topic_maps/_topic_map.yml

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2592,6 +2592,29 @@ Topics:
25922592
- Name: OpenShift sandboxed containers documentation has been moved
25932593
File: sandboxed-containers-moved
25942594
---
2595+
Name: Observability
2596+
Dir: observability
2597+
Distros: openshift-enterprise,openshift-origin
2598+
Topics:
2599+
- Name: Observability overview
2600+
File: index
2601+
- Name: Power Monitoring
2602+
Dir: power_monitoring
2603+
Distros: openshift-enterprise,openshift-origin
2604+
Topics:
2605+
- Name: Power monitoring release notes
2606+
File: power-monitoring-release-notes
2607+
- Name: Power monitoring overview
2608+
File: power-monitoring-overview
2609+
- Name: Installing power monitoring
2610+
File: installing-power-monitoring
2611+
- Name: Configuring power monitoring
2612+
File: configuring-power-monitoring
2613+
- Name: Visualizing power monitoring metrics
2614+
File: visualizing-power-monitoring-metrics
2615+
- Name: Uninstalling power monitoring
2616+
File: uninstalling-power-monitoring
2617+
---
25952618
Name: Logging
25962619
Dir: logging
25972620
Distros: openshift-enterprise,openshift-origin
@@ -2740,23 +2763,6 @@ Topics:
27402763
- Name: Configuring the Cluster Observability Operator to monitor a service
27412764
File: configuring-the-cluster-observability-operator-to-monitor-a-service
27422765
---
2743-
Name: Power monitoring
2744-
Dir: power_monitoring
2745-
Distros: openshift-enterprise,openshift-origin
2746-
Topics:
2747-
- Name: Power monitoring release notes
2748-
File: power-monitoring-release-notes
2749-
- Name: Power monitoring overview
2750-
File: power-monitoring-overview
2751-
- Name: Installing power monitoring
2752-
File: installing-power-monitoring
2753-
- Name: Configuring power monitoring
2754-
File: configuring-power-monitoring
2755-
- Name: Visualizing power monitoring metrics
2756-
File: visualizing-power-monitoring-metrics
2757-
- Name: Uninstalling power monitoring
2758-
File: uninstalling-power-monitoring
2759-
---
27602766
Name: Distributed tracing
27612767
Dir: distr_tracing
27622768
Distros: openshift-enterprise
File renamed without changes.

observability/hugeBook.flag

Whitespace-only changes.
File renamed without changes.

observability/index.adoc

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="observability-overview"]
3+
= {product-title} Observability overview
4+
include::_attributes/common-attributes.adoc[]
5+
:context: observability-overview
6+
7+
toc::[]
8+
9+
10+
{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:
11+
12+
* Monitoring
13+
* {logging-uc}
14+
* Distributed tracing
15+
* {OTELName}
16+
* Network Observability
17+
* {PM-shortname-c}
18+
19+
{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.
20+
21+
[id="monitoring-overview-index"]
22+
== Monitoring
23+
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.
24+
25+
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.
26+
27+
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].
28+
//after the file is added to the observability directory, update xref path to ../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview].
29+
30+
[id="cluster-logging-index"]
31+
== Logging
32+
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.
33+
34+
For more information, see xref:../logging/cluster-logging.adoc#cluster-logging[About Logging].
35+
//after the file is added to the observability directory, update xref path to ../observability/logging/cluster-logging.adoc#cluster-logging[About Logging].
36+
37+
[id="distr-tracing-architecture-index"]
38+
== Distributed tracing
39+
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.
40+
41+
For more information, see xref:../distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distributed-tracing-architecture[Distributed tracing architecture].
42+
//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].
43+
44+
[id="otel-release-notes-index"]
45+
== {OTELName}
46+
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.
47+
48+
For more information, see xref:../otel/otel-release-notes.adoc#otel-release-notes[{OTELName} release notes].
49+
//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].
50+
51+
[id="network-observability-overview-index"]
52+
== Network Observability
53+
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.
54+
55+
For more information, see xref:../network_observability/network-observability-overview.adoc#network-observability-overview[Network Observability overview].
56+
//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].
57+
58+
[id="power-monitoring-overview-index"]
59+
== Power monitoring
60+
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}.
61+
62+
For more information, see xref:../observability/power_monitoring/power-monitoring-overview.adoc#power-monitoring-overview[Power Monitoring overview].
File renamed without changes.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../_attributes/
File renamed without changes.

observability/power_monitoring/images

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../images/

0 commit comments

Comments
 (0)