Docs » Instrument back-end applications to send spans to Splunk APM » Instrument Ruby applications for Splunk Observability Cloud » Troubleshoot Ruby instrumentation for Splunk Observability Cloud

Troubleshoot Ruby instrumentation for Splunk Observability Cloud ๐Ÿ”—

When you instrument a Ruby application using the Splunk Distribution of OpenTelemetry Ruby and you donโ€™t see your data in Observability Cloud, follow these troubleshooting steps.

Steps for troubleshooting Ruby OpenTelemetry issues ๐Ÿ”—

The following steps can help you troubleshoot Ruby instrumentation issues:

  1. Enable debug logging.

Enable debug logging ๐Ÿ”—

Debug logging increases the verbosity of the Ruby instrumentation. This can help you troubleshoot issues. To enable debug logging, set the OTEL_LOG_LEVEL environment variable to debug.

export OTEL_LOG_LEVEL="debug"

Make sure to unset the environment variable after the issue is resolved, as its output might overload systems if left on indefinitely.

Trace exporter issues ๐Ÿ”—

By default, the Splunk Distribution of OpenTelemetry Ruby uses the OTLP exporter. Any issue affecting the export of traces produces an error in the debug logs.

OTLP canโ€™t export spans ๐Ÿ”—

To troubleshoot the lack of connectivity between the OTLP exporter and the OTel Collector, try the following:

  1. Make sure that OTEL_EXPORTER_OTLP_ENDPOINT points to the correct OpenTelemetry Collector instance host.

  2. Check that your collector instance is configured and running. See Troubleshoot issues when collecting data.

  3. Check that the OTLP receiver is enabled in the OTel Collector and plugged into the traces pipeline.

  4. Check that the OTel Collector points to the following address: http://<host>:4318. Verify that your URL is correct.

401 error when sending spans ๐Ÿ”—

If you send traces directly to Observability Cloud and receive a 401 error code, the authentication token specified in SPLUNK_ACCESS_TOKEN is invalid. The following are possible reasons:

  • The value is null.

  • The value is not a well-formed token.

  • The token is not an access token that has authScope set to ingest.

Make sure that youโ€™re using a valid Splunk access token when sending data directly to your Splunk platform instance. See Retrieve and manage user API access tokens using Splunk Observability Cloud.

Report an issue ๐Ÿ”—

Before you create an issue or open a support request, try gathering the following information:

  • What happened and the impact of the issue.

  • All the steps youโ€™ve followed until the issue appeared.

  • What was the expected outcome.

  • Your attempts to solve the issue, including workarounds.

  • The operating system, runtime or compiler version, libraries, frameworks, and application servers of your environment, including your instrumentation settings.

  • Debug logs and other logs that might help troubleshoot the issue.

To get help, see Splunk Observability Cloud support.