From f47eb91a11c122a20c3a9cc67552372316f92e22 Mon Sep 17 00:00:00 2001 From: Israel Blancas Date: Wed, 2 Oct 2024 17:25:02 +0200 Subject: [PATCH] OBSDOCS-1413: Document how to verify if receivers/exporters are sending/receiving data based on the OTEL Collector metrics Signed-off-by: Israel Blancas --- modules/otel-troubleshoot-metrics.adoc | 23 ++++++++++---------- observability/otel/otel-troubleshooting.adoc | 4 ++++ 2 files changed, 16 insertions(+), 11 deletions(-) diff --git a/modules/otel-troubleshoot-metrics.adoc b/modules/otel-troubleshoot-metrics.adoc index 4abff7b44e7b..37cf3155042a 100644 --- a/modules/otel-troubleshoot-metrics.adoc +++ b/modules/otel-troubleshoot-metrics.adoc @@ -6,14 +6,22 @@ [id="exposing-metrics_{context}"] = Exposing the metrics -The OpenTelemetry Collector exposes the metrics about the data volumes it has processed. The following metrics are for spans, although similar metrics are exposed for metrics and logs signals: +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. `otelcol_exporter_sent_spans`:: The number of spans successfully sent to the destination. - `otelcol_exporter_enqueue_failed_spans`:: The number of spans failed to be added to the sending queue. +`otelcol_receiver_accepted_logs`:: The number of logs successfully pushed into the pipeline. +`otelcol_receiver_refused_logs`:: The number of logs that could not be pushed into the pipeline. +`otelcol_exporter_sent_logs`:: The number of logs successfully sent to the destination. +`otelcol_exporter_enqueue_failed_logs`:: The number of logs failed to be added to the sending queue. +`otelcol_receiver_accepted_metrics`:: The number of metrics successfully pushed into the pipeline. +`otelcol_receiver_refused_metrics`:: The number of metrics that could not be pushed into the pipeline. +`otelcol_exporter_sent_metrics`:: The number of metrics successfully sent to the destination. +`otelcol_exporter_enqueue_failed_metrics`:: The number of metrics failed to be added to the sending queue. + +You can use these metrics to troubleshoot issues with your Collector. For example, if the `otelcol_receiver_refused_spans` metric has a high value, it indicates that the Collector is not able to process incoming spans. The Operator creates a `-collector-monitoring` telemetry service that you can use to scrape the metrics endpoint. @@ -68,14 +76,7 @@ Depending on the deployment mode of the OpenTelemetry Collector, the internal me Alternatively, if you do not set the `enableMetrics` field to `true`, you can access the metrics endpoint at `+http://localhost:8888/metrics+`. ==== -. On the *Observe* page in the web console, enable *User Workload Monitoring* to visualize the scraped metrics. -+ -[NOTE] -==== -Not all processors expose the required metrics. -==== - -. In the web console, go to *Observe* -> *Dashboards* and select the *OpenTelemetry Collector* dashboard from the drop-down list to view it. +. Optional: If the *User Workload Monitoring* feature is enabled in the web console, go to *Observe* -> *Dashboards* in the web console, and then select the *OpenTelemetry Collector* dashboard from the drop-down list to view it. For more information about the *User Workload Monitoring* feature, see "Enabling monitoring for user-defined projects" in _Monitoring_. + [TIP] ==== diff --git a/observability/otel/otel-troubleshooting.adoc b/observability/otel/otel-troubleshooting.adoc index 5ca6bb5df761..8dfe822118c4 100644 --- a/observability/otel/otel-troubleshooting.adoc +++ b/observability/otel/otel-troubleshooting.adoc @@ -14,6 +14,10 @@ include::modules/otel-troubleshoot-collector-logs.adoc[leveloffset=+1] include::modules/otel-troubleshoot-metrics.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* xref:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects] + include::modules/otel-troubleshoot-debug-exporter-stdout.adoc[leveloffset=+1] include::modules/otel-troubleshoot-network-traffic.adoc[leveloffset=+1]