⚠️ Deprecation Notice

The Splunk Distribution of OpenTelemetry Ruby is deprecated as of March 15, 2024 and will reach end of Support on March 15, 2025. Until then, only critical security fixes and bug fixes will be provided. After the date, this repository will be archived and no longer maintained. New customers instrumenting Ruby applications should use the OpenTelemetry Distribution of Ruby. Existing customers should consider migrating to OpenTelemetry Distribution of Ruby which offers similar capabilities. To learn how to instrument Ruby code see the Splunk documentation.

The Splunk Distribution of OpenTelemetry Instrumentation for Ruby provides a gem for setup of OpenTelemetry SDK for reporting distributed traces to Splunk APM.

This distribution comes with the following defaults:

• W3C tracecontext and baggage propagation.
• OTLP exporter configured to send spans to a locally running OpenTelemetry Collector over HTTP (default endpoint: localhost:4318).
• Unlimited default limits for configuration options to support full-fidelity traces.

If you're using the SignalFx Tracing Library for Ruby and want to migrate to the Splunk Distribution of OpenTelemetry Ruby, see Migrate from the SignalFx Tracing Library for Ruby in the official documentation.

This distribution requires Ruby version 3.0 or higher.

For complete instructions on how to get started with the Splunk Distribution of OpenTelemetry Ruby, see Instrument a Ruby application for Splunk Observability Cloud in the official documentation.

See Configure the Ruby agent for Splunk Observability Cloud in the official documentation.

You can add trace metadata to logs using the OpenTelemetry trace API. Trace metadata lets you explore logs in Splunk Observability Cloud.

See Connect Ruby trace data with logs for Splunk Observability Cloud in the official documentation.

Supported libraries are listed here. You can find the corresponding gems for the instrumentation libraries under the opentelemetry-ruby profile on rubygems.org.

See Manually instrument Ruby applications for Splunk Observability Cloud for instructions on how to manually instrument Ruby applications.

This distribution includes the jaeger-thrift-splunk exporter, which is preconfigured to send data to local instance of the SignalFx Smart Agent.

To use the jaeger-thrift-splunk exporter, set theOTEL_TRACES_EXPORTER environment variable to jaeger-thrift-splunk, or append the exporter to the existing values. For example, OTEL_TRACES_EXPORTER=otlp,jaeger-thrift-splunk.

If the SPLUNK_REALM or the OTEL_EXPORTER_JAEGER_ENDPOINT environmental variables are set, the default endpoint is overwritten.

For troubleshooting information, see the Troubleshoot Ruby instrumentation for Splunk Observability Cloud in the official documentation.

The Splunk OpenTelemetry Ruby distribution is licensed under the terms of the Apache Software License version 2.0. For more details, see the license file.

Copyright 2021 Splunk Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.