Skip to content

Commit e875be2

Browse files
Israel Blancasopenshift-cherrypick-robot
authored andcommitted
OBSDOCS-1413: Document how to verify if receivers/exporters are sending/receiving data based on the OTEL Collector metrics
Signed-off-by: Israel Blancas <iblancas@redhat.com>
1 parent 651f18e commit e875be2

File tree

2 files changed

+16
-11
lines changed

2 files changed

+16
-11
lines changed

modules/otel-troubleshoot-metrics.adoc

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,22 @@
66
[id="exposing-metrics_{context}"]
77
= Exposing the metrics
88

9-
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:
9+
The OpenTelemetry Collector exposes the following metrics about the data volumes it has processed:
1010

1111
`otelcol_receiver_accepted_spans`:: The number of spans successfully pushed into the pipeline.
12-
1312
`otelcol_receiver_refused_spans`:: The number of spans that could not be pushed into the pipeline.
1413
`otelcol_exporter_sent_spans`:: The number of spans successfully sent to the destination.
15-
1614
`otelcol_exporter_enqueue_failed_spans`:: The number of spans failed to be added to the sending queue.
15+
`otelcol_receiver_accepted_logs`:: The number of logs successfully pushed into the pipeline.
16+
`otelcol_receiver_refused_logs`:: The number of logs that could not be pushed into the pipeline.
17+
`otelcol_exporter_sent_logs`:: The number of logs successfully sent to the destination.
18+
`otelcol_exporter_enqueue_failed_logs`:: The number of logs failed to be added to the sending queue.
19+
`otelcol_receiver_accepted_metrics`:: The number of metrics successfully pushed into the pipeline.
20+
`otelcol_receiver_refused_metrics`:: The number of metrics that could not be pushed into the pipeline.
21+
`otelcol_exporter_sent_metrics`:: The number of metrics successfully sent to the destination.
22+
`otelcol_exporter_enqueue_failed_metrics`:: The number of metrics failed to be added to the sending queue.
23+
24+
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.
1725

1826
The Operator creates a `<cr_name>-collector-monitoring` telemetry service that you can use to scrape the metrics endpoint.
1927

@@ -68,14 +76,7 @@ Depending on the deployment mode of the OpenTelemetry Collector, the internal me
6876
Alternatively, if you do not set the `enableMetrics` field to `true`, you can access the metrics endpoint at `+http://localhost:8888/metrics+`.
6977
====
7078

71-
. On the *Observe* page in the web console, enable *User Workload Monitoring* to visualize the scraped metrics.
72-
+
73-
[NOTE]
74-
====
75-
Not all processors expose the required metrics.
76-
====
77-
78-
. In the web console, go to *Observe* -> *Dashboards* and select the *OpenTelemetry Collector* dashboard from the drop-down list to view it.
79+
. 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_.
7980
+
8081
[TIP]
8182
====

observability/otel/otel-troubleshooting.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ include::modules/otel-troubleshoot-collector-logs.adoc[leveloffset=+1]
1414

1515
include::modules/otel-troubleshoot-metrics.adoc[leveloffset=+1]
1616

17+
[role="_additional-resources"]
18+
.Additional resources
19+
* xref:../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects]
20+
1721
include::modules/otel-troubleshoot-debug-exporter-stdout.adoc[leveloffset=+1]
1822

1923
include::modules/otel-troubleshoot-network-traffic.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)