Splunk Distribution of OpenTelemetry Ruby
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.
configured to send spans to a locally running OpenTelemetry
HTTP (default endpoint:
- 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 2.6 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.
Correlate traces and logs
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.
See Manually instrument Ruby applications for Splunk Observability Cloud for instructions on how to manually instrument Ruby applications.
Configure for use with Smart Agent
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 the
OTEL_TRACES_EXPORTER environment variable to
jaeger-thrift-splunk, or append the exporter to the existing values. For example,
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
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.