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

1
observability/_attributes Symbolic link
View File

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

View File

1
observability/images Symbolic link
View File

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

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

1
observability/modules Symbolic link
View File

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

View File

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

View File

@@ -0,0 +1,16 @@
:_mod-docs-content-type: ASSEMBLY
[id="configuring-power-monitoring"]
= Configuring {PM-shortname}
include::_attributes/common-attributes.adoc[]
:context: configuring-power-monitoring
toc::[]
:FeatureName: Power monitoring
include::snippets/technology-preview.adoc[leveloffset=+2]
The `{PM-kepler}` resource is a Kubernetes custom resource definition (CRD) that enables you to configure the deployment and monitor the status of the {PM-kepler} resource.
include::modules/power-monitoring-kepler-configuration.adoc[leveloffset=+1]
include::modules/power-monitoring-monitoring-kepler-status.adoc[leveloffset=+1]

View File

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

View File

@@ -0,0 +1,18 @@
:_mod-docs-content-type: ASSEMBLY
[id="installing-power-monitoring"]
= Installing {PM-title}
include::_attributes/common-attributes.adoc[]
:context: installing-power-monitoring
toc::[]
:FeatureName: Power monitoring
include::snippets/technology-preview.adoc[leveloffset=+2]
You can install {PM-title} by deploying the {PM-operator} in the {product-title} web console.
//Installing power monitoring operator
include::modules/power-monitoring-installing-pmo.adoc[leveloffset=+1]
// Deploying Kepler
include::modules/power-monitoring-deploying-kepler.adoc[leveloffset=+1]

View File

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

View File

@@ -0,0 +1,21 @@
:_mod-docs-content-type: ASSEMBLY
[id="power-monitoring-overview"]
= {PM-shortname-c} overview
include::_attributes/common-attributes.adoc[]
:context: power-monitoring-overview
toc::[]
:FeatureName: Power monitoring
include::snippets/technology-preview.adoc[leveloffset=+2]
include::modules/power-monitoring-about-power-monitoring.adoc[leveloffset=+1]
include::modules/power-monitoring-kepler-architecture.adoc[leveloffset=+1]
include::modules/power-monitoring-hardware-virtualization-support.adoc[leveloffset=+1]
[role="_additional-resources"]
[id="additional-resources_power-monitoring-overview"]
== Additional resources
* xref:../power_monitoring/visualizing-power-monitoring-metrics.adoc#power-monitoring-dashboards-overview_visualizing-power-monitoring-metrics[{PM-shortname-c} dashboards overview]

View File

@@ -0,0 +1,30 @@
:_mod-docs-content-type: ASSEMBLY
[id="power-monitoring-release-notes"]
include::_attributes/common-attributes.adoc[]
= {PM-title-c} release notes
:context: power-monitoring-release-notes
toc::[]
:FeatureName: Power monitoring
include::snippets/technology-preview.adoc[leveloffset=+2]
{PM-title-c} enables you to monitor the power usage of workloads and identify the most power-consuming namespaces running in an {product-title} cluster with key power consumption metrics, such as CPU or DRAM, measured at container level.
These release notes track the development of {PM-title} in the {product-title}.
For an overview of the {PM-operator}, see xref:../power_monitoring/power-monitoring-overview.adoc#power-monitoring-about-power-monitoring_power-monitoring-overview[About {PM-shortname}].
[id="power-monitoring-release-notes-0-1"]
== {PM-shortname-c} 0.1 (Technology Preview)
This release introduces a Technology Preview version of {PM-title}. The following advisory is available for {PM-shortname} 0.1:
* link:https://access.redhat.com/errata/RHEA-2024:0078[RHEA-2024:0078]
[id="power-monitoring-release-notes-0-1-features"]
=== Features
* Deployment and deletion of {PM-kepler}
* Power usage metrics from Intel-based bare-metal deployments
* Dashboards for plotting power usage

View File

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

View File

@@ -0,0 +1,18 @@
:_mod-docs-content-type: ASSEMBLY
[id="uninstalling-power-monitoring"]
= Uninstalling {PM-shortname}
include::_attributes/common-attributes.adoc[]
:context: uninstalling-power-monitoring
toc::[]
:FeatureName: Power monitoring
include::snippets/technology-preview.adoc[leveloffset=+2]
You can uninstall {PM-shortname} by deleting the {PM-kepler} instance and then the {PM-operator} in the {product-title} web console.
// Removing kepler
include::modules/power-monitoring-deleting-kepler.adoc[leveloffset=+1]
// Uninstalling power monitoring operator
include::modules/power-monitoring-uninstalling-pmo.adoc[leveloffset=+1]

View File

@@ -0,0 +1,23 @@
:_mod-docs-content-type: ASSEMBLY
[id="visualizing-power-monitoring-metrics"]
= Visualizing power monitoring metrics
include::_attributes/common-attributes.adoc[]
:context: visualizing-power-monitoring-metrics
toc::[]
:FeatureName: Power monitoring
include::snippets/technology-preview.adoc[leveloffset=+2]
You can visualize {PM-shortname} metrics in the {product-title} web console by accessing {PM-shortname} dashboards or by exploring *Metrics* under the *Observe* tab.
include::modules/power-monitoring-dashboards-overview.adoc[leveloffset=+1]
include::modules/power-monitoring-accessing-dashboards.adoc[leveloffset=+1]
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]
//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