diff --git a/config-collector-metrics/otel-configuring-otelcol-metrics.adoc b/config-collector-metrics/otel-configuring-otelcol-metrics.adoc index d5c1c5782182..ee86a5ad4125 100644 --- a/config-collector-metrics/otel-configuring-otelcol-metrics.adoc +++ b/config-collector-metrics/otel-configuring-otelcol-metrics.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY include::_attributes/common-attributes.adoc[] [id="otel-configuring-metrics"] -= Configuring the OpenTelemetry Collector metrics += Configure Collector metrics :context: otel-configuring-metrics include::modules/otel-collector-metrics-overview.adoc[leveloffset=+1] diff --git a/modules/otel-collector-metrics-overview.adoc b/modules/otel-collector-metrics-overview.adoc index 08e9b5c58b38..1c3b748dc498 100644 --- a/modules/otel-collector-metrics-overview.adoc +++ b/modules/otel-collector-metrics-overview.adoc @@ -4,10 +4,10 @@ :_mod-docs-content-type: CONCEPT [id="otel-collector-metrics-overview_{context}"] -= OpenTelemetry Collector metrics overview += Collector metrics overview [role="_abstract"] -The {OTelOperator} automatically creates a service named `-collector-monitoring` that exposes the Collector's internal metrics, including the following listed metrics. +The {OTelOperator} automatically creates a service named `-collector-monitoring` that exposes the OpenTelemetry Collector's internal metrics, including the following listed metrics. * Collector memory usage * CPU usage diff --git a/modules/otel-enabling-collector-metrics.adoc b/modules/otel-enabling-collector-metrics.adoc index 28c7884107b3..094794ec3862 100644 --- a/modules/otel-enabling-collector-metrics.adoc +++ b/modules/otel-enabling-collector-metrics.adoc @@ -4,10 +4,10 @@ :_mod-docs-content-type: PROCEDURE [id="otel-enabling-collector-metrics_{context}"] -= Enabling OpenTelemetry Collector metrics += Enable Collector metrics [role="_abstract"] -You can use the Collector's internal metrics for monitoring the Collector's performance, resource consumption, and other internal behaviors. You can also use a Prometheus instance or another monitoring tool to scrape these metrics from the mentioned `-collector-monitoring` service. +You can use the OpenTelemetry Collector's internal metrics for monitoring the Collector's performance, resource consumption, and other internal behaviors. You can also use a Prometheus instance or another monitoring tool to scrape these metrics from the mentioned `-collector-monitoring` service. .Prerequisites diff --git a/modules/otel-troubleshoot-collecting-diagnostic-data-from-command-line.adoc b/modules/otel-troubleshoot-collecting-diagnostic-data-from-command-line.adoc index 7aa8fe2e17b6..3be7a0c2089e 100644 --- a/modules/otel-troubleshoot-collecting-diagnostic-data-from-command-line.adoc +++ b/modules/otel-troubleshoot-collecting-diagnostic-data-from-command-line.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: PROCEDURE [id="otel-collecting-diagnostic-data-from-command-line_{context}"] -= Collecting diagnostic data from the command line += Collect diagnostic data [role="_abstract"] When submitting a support case, it is helpful to include diagnostic information about your cluster to Red Hat Support. diff --git a/modules/otel-troubleshoot-collector-logs.adoc b/modules/otel-troubleshoot-collector-logs.adoc index 2c5150af8f32..da0672879aa5 100644 --- a/modules/otel-troubleshoot-collector-logs.adoc +++ b/modules/otel-troubleshoot-collector-logs.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: PROCEDURE [id="getting-otel-collector-logs_{context}"] -= Getting the OpenTelemetry Collector logs += Get Collector logs [role="_abstract"] You can get the logs for the OpenTelemetry Collector as follows. diff --git a/modules/otel-troubleshoot-debug-exporter-stdout.adoc b/modules/otel-troubleshoot-debug-exporter-stdout.adoc index 0b19976e4962..9a61a89755eb 100644 --- a/modules/otel-troubleshoot-debug-exporter-stdout.adoc +++ b/modules/otel-troubleshoot-debug-exporter-stdout.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: PROCEDURE [id="debug-exporter-to-stdout_{context}"] -= Debug Exporter += Export logs to stdout [role="_abstract"] You can configure the Debug Exporter to export the collected data to the standard output. diff --git a/modules/otel-troubleshoot-metrics.adoc b/modules/otel-troubleshoot-metrics.adoc index 7ad0b7ee641c..6a7d35758c24 100644 --- a/modules/otel-troubleshoot-metrics.adoc +++ b/modules/otel-troubleshoot-metrics.adoc @@ -4,10 +4,10 @@ :_mod-docs-content-type: PROCEDURE [id="exposing-metrics_{context}"] -= Exposing the metrics += Expose metrics [role="_abstract"] -The OpenTelemetry Collector exposes the following metrics about the data volumes it has processed: +The OpenTelemetry Collector exposes the following metrics about the data volumes it has processed. `otelcol_receiver_accepted_spans`:: The number of spans successfully pushed into the pipeline. `otelcol_receiver_refused_spans`:: The number of spans that could not be pushed into the pipeline. diff --git a/modules/otel-troubleshoot-network-policies.adoc b/modules/otel-troubleshoot-network-policies.adoc index 08ee424781db..685aa11a27a5 100644 --- a/modules/otel-troubleshoot-network-policies.adoc +++ b/modules/otel-troubleshoot-network-policies.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: PROCEDURE [id="troubleshoot-network-policies_{context}"] -= Disabling network policies += Disable network policies [role="_abstract"] The {OTelOperator} creates network policies to control the traffic for the Operator and operands to improve security. diff --git a/modules/otel-troubleshoot-network-traffic.adoc b/modules/otel-troubleshoot-network-traffic.adoc index 92797923644a..9998eeb99866 100644 --- a/modules/otel-troubleshoot-network-traffic.adoc +++ b/modules/otel-troubleshoot-network-traffic.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: PROCEDURE [id="using-network-observability-operator-for-troubleshooting_{context}"] -= Using the Network Observability Operator for troubleshooting += Debug network traffic [role="_abstract"] You can debug the traffic between your observability components by visualizing it with the Network Observability Operator. diff --git a/modules/otel-troubleshooting-instrumentation-injection-into-your-workload.adoc b/modules/otel-troubleshooting-instrumentation-injection-into-your-workload.adoc index 03b58d9f0197..b06317f17893 100644 --- a/modules/otel-troubleshooting-instrumentation-injection-into-your-workload.adoc +++ b/modules/otel-troubleshooting-instrumentation-injection-into-your-workload.adoc @@ -4,16 +4,16 @@ :_mod-docs-content-type: PROCEDURE [id="otel-troubleshooting-instrumentation-injection-into-your-workload_{context}"] -= Troubleshooting instrumentation injection into your workload += Troubleshoot instrumentation injection [role="_abstract"] -To troubleshoot instrumentation injection, you can perform the following activities: +To troubleshoot instrumentation injection into your workload, you can perform the following checks. -* Checking if the `Instrumentation` object was created -* Checking if the init-container started -* Checking if the resources were deployed in the correct order -* Searching for errors in the Operator logs -* Double-checking the pod annotations +* Check if the `Instrumentation` object was created. +* Check if the init-container started. +* Check if the resources were deployed in the correct order. +* Check for errors in the Operator logs. +* Check the pod annotations. .Procedure diff --git a/modules/otel-troubleshooting-telemetry-data-generation-by-the-instrumentation-libraries.adoc b/modules/otel-troubleshooting-telemetry-data-generation-by-the-instrumentation-libraries.adoc index 939c5fc83342..8c699b6b7c12 100644 --- a/modules/otel-troubleshooting-telemetry-data-generation-by-the-instrumentation-libraries.adoc +++ b/modules/otel-troubleshooting-telemetry-data-generation-by-the-instrumentation-libraries.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: PROCEDURE [id="otel-troubleshooting-telemetry-data-generation-by-the-instrumentation-libraries_{context}"] -= Troubleshooting telemetry data generation by the instrumentation libraries += Troubleshoot instrumentation libraries [role="_abstract"] You can troubleshoot telemetry data generation by the instrumentation libraries by checking the endpoint, looking for errors in your application logs, and verifying that the Collector is receiving the telemetry data. diff --git a/troubleshooting/otel-troubleshooting.adoc b/troubleshooting/otel-troubleshooting.adoc index a3fd5818c7dc..56c93a139920 100644 --- a/troubleshooting/otel-troubleshooting.adoc +++ b/troubleshooting/otel-troubleshooting.adoc @@ -1,13 +1,13 @@ :_mod-docs-content-type: ASSEMBLY include::_attributes/common-attributes.adoc[] [id="otel-troubleshoot"] -= Troubleshooting += Troubleshoot the {otel} :context: otel-troubleshoot toc::[] [role="_abstract"] -The OpenTelemetry Collector offers multiple ways to measure its health and investigate data ingestion issues. +You can troubleshoot the OpenTelemetry Collector and instrumentation issues by using a mix of the following solutions. include::modules/otel-troubleshoot-collecting-diagnostic-data-from-command-line.adoc[leveloffset=+1]