Skip to content

Commit c9286be

Browse files
committed
OBSDOCS-949-conditionalize-observability-overview
1 parent 79c9af7 commit c9286be

File tree

3 files changed

+21
-9
lines changed

3 files changed

+21
-9
lines changed

_topic_maps/_topic_map_osd.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1149,6 +1149,8 @@ Name: Observability
11491149
Dir: observability
11501150
Distros: openshift-dedicated
11511151
Topics:
1152+
- Name: Observability overview
1153+
File: index
11521154
- Name: Monitoring
11531155
Dir: monitoring
11541156
Distros: openshift-dedicated

_topic_maps/_topic_map_rosa.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1403,6 +1403,8 @@ Name: Observability
14031403
Dir: observability
14041404
Distros: openshift-rosa
14051405
Topics:
1406+
- Name: Observability overview
1407+
File: index
14061408
- Name: Monitoring
14071409
Dir: monitoring
14081410
Distros: openshift-rosa

observability/index.adoc

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,23 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
9+
ifndef::openshift-dedicated,openshift-rosa[]
1010
{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+
endif::openshift-dedicated,openshift-rosa[]
12+
13+
ifdef::openshift-dedicated,openshift-rosa[]
14+
{ObservabilityLongName} provides real-time visibility, monitoring, and analysis of various system metrics, logs, 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:
15+
endif::openshift-dedicated,openshift-rosa[]
1116

1217
* Monitoring
13-
* {logging-uc}
18+
* {logging-uc}
19+
ifndef::openshift-dedicated,openshift-rosa[]
1420
* Distributed tracing
1521
* {OTELName}
1622
* Network Observability
1723
* {PM-shortname-c}
24+
endif::openshift-dedicated,openshift-rosa[]
25+
1826
1927
{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.
2028

@@ -24,28 +32,26 @@ Monitor the in-cluster health and performance of your applications running on {p
2432

2533
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.
2634

27-
For more information, see xref:../observability/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].
35+
For more information, see xref:../observability/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].
2836

2937
[id="cluster-logging-index"]
30-
== Logging
38+
== Logging
3139
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.
3240

3341
For more information, see xref:../observability/logging/cluster-logging.adoc#cluster-logging[About Logging].
34-
//after the file is added to the observability directory, update xref path to ../observability/logging/cluster-logging.adoc#cluster-logging[About Logging].
3542

43+
ifdef::openshift-enterprise,openshift-origin[]
3644
[id="distr-tracing-architecture-index"]
3745
== Distributed tracing
3846
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.
3947

4048
For more information, see xref:distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distributed-tracing-architecture[Distributed tracing architecture].
41-
//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].
4249

4350
[id="otel-release-notes-index"]
4451
== {OTELName}
45-
Instrument, generate, collect, and export telemetry traces, metrics, and logs to analyze and understand your software's performance and behavior. Use open-source back ends like Tempo or Prometheus, or use commercial offerings. Learn a single set of APIs and conventions, and own the data that you generate.
52+
Instrument, generate, collect, and export telemetry traces, metrics, and logs to analyze and understand your software's performance and behavior. Use open-source back ends like Tempo or Prometheus, or use commercial offerings. Learn a single set of APIs and conventions, and own the data that you generate.
4653

4754
For more information, see xref:otel/otel-installing.adoc#install-otel[{OTELName}].
48-
//possibly outdated comment: 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].
4955

5056
[id="network-observability-overview-index"]
5157
== Network Observability
@@ -54,7 +60,9 @@ Observe the network traffic for {product-title} clusters and create network flow
5460
For more information, see xref:../observability/network_observability/network-observability-overview.adoc#network-observability-overview[Network Observability overview].
5561

5662
[id="power-monitoring-overview-index"]
57-
== Power monitoring
63+
== Power monitoring
5864
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 the container level. Visualize energy-related system statistics with the {PM-operator}.
5965

6066
For more information, see xref:../observability/power_monitoring/power-monitoring-overview.adoc#power-monitoring-overview[Power monitoring overview].
67+
endif::[]
68+

0 commit comments

Comments
 (0)