Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions _attributes/common-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,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
Expand Down
7 changes: 7 additions & 0 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2387,6 +2387,13 @@ Topics:
- Name: Collecting OpenShift sandboxed containers data
File: troubleshooting-sandboxed-containers
---
Name: Observability
Dir: observability
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Observability overview
File: index
---
Name: Logging
Dir: logging
Distros: openshift-enterprise,openshift-origin
Expand Down
1 change: 1 addition & 0 deletions observability/_attributes
Empty file added observability/hugeBook.flag
Empty file.
1 change: 1 addition & 0 deletions observability/images
56 changes: 56 additions & 0 deletions observability/index.adoc
Original file line number Diff line number Diff line change
@@ -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].

1 change: 1 addition & 0 deletions observability/modules
1 change: 1 addition & 0 deletions observability/snippets