open-telemetry / opentelemetry-demo

Troubleshooting - open-telemetry/opentelemetry-demo

Troubleshooting OpenTelemetry Demo Project

When encountering issues during the development, deployment, or usage of the OpenTelemetry demo project, the following troubleshooting options are available, with examples and references to the official documentation.

  1. OpenTelemetry Collector Receiver issues

If your telemetry client generated data but it hasn’t been received by your backend, use the metric otelcol_receiver_accepted_spans to ensure that the data point has been received by the Collector. If you expect a data point to have been counted as part of this metric but hasn’t, check the metric otelcol_receiver_refused_spans to ensure it wasn’t refused by the Collector.

Source: https://grafana.com/docs/opentelemetry/collector/troubleshooting/#receiver-issues

  1. Sending test data

For certain types of issues, particularly verifying configuration and debugging network issues, it can be helpful to send a small amount of data to a collector configured to output to local logs.

Source: https://opentelemetry.io/docs/collector/troubleshooting/#sending-test-data

  1. Checklist for debugging complex pipelines

It can be difficult to isolate problems when telemetry flows through multiple collectors and networks. For each “hop” of telemetry data through a collector or other component in your telemetry pipeline, it’s important to verify the health and performance.

Source: https://opentelemetry.io/docs/collector/troubleshooting/#checklist-for-debugging-complex-pipelines

  1. Enable Logging

OpenTelemetry JS will by default not log anything to its diagnostic logger. Most issues can be diagnosed by enabling logging.

Source: https://grafana.com/docs/agent/latest/static/configuration/traces-config/#enable-logging

  1. Check the configuration file

Check the configuration file for any misconfigurations or errors. The configuration file is located at /etc/otelcol/config.yaml.

Source: https://grafana.com/blog/2022/05/10/how-to-collect-prometheus-metrics-with-the-opentelemetry-collector-and-grafana

  1. Check the status of the OpenTelemetry Collector

Use the command sudo systemctl status otelcol to check the status of the OpenTelemetry Collector.

Source: https://opentelemetry.io/docs/collector/getting-started/#open-http-localhost55679-debug-tracez-in-your-browser-and-select-one-of-the-samples-in-the-table-to-see-the-traces-you-ve-just-generated

  1. Check the OpenTelemetry documentation

The OpenTelemetry documentation provides a comprehensive guide to troubleshooting issues that may arise during development, deployment, or usage.

Source: https://opentelemetry.io/docs/collector/troubleshooting/

  1. Check the Grafana documentation

The Grafana documentation provides a comprehensive guide to troubleshooting the OpenTelemetry Collector.

Source: https://grafana.com/docs/opentelemetry/collector/troubleshooting/