Skip to content

[enterprise-4.12] OBSDOCS-1413: Document how to verify if receivers/exporters are sending/receiving data based on the OTEL Collector metrics #96318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: enterprise-4.12
Choose a base branch
from
Open
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
23 changes: 12 additions & 11 deletions modules/otel-troubleshoot-metrics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<cr_name>-collector-monitoring` telemetry service that you can use to scrape the metrics endpoint.

Expand Down Expand Up @@ -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]
====
Expand Down
4 changes: 4 additions & 0 deletions observability/otel/otel-troubleshooting.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down