Migrate from the SignalFx Tracing Library for Ruby

The agent of the Splunk Distribution of OpenTelemetry Ruby replaces the deprecated SignalFx Ruby Tracing Library. To migrate to the Splunk Ruby OTel agent, follow these instructions.

The SignalFx Ruby tracing library is deprecated and reached End of Support on September 30th, 2023. Replace it with the agent from the Splunk Distribution of OpenTelemetry Ruby.

The agent of the Splunk Distribution of OpenTelemetry Ruby is based on the OpenTelemetry Instrumentation for Ruby, an open-source project that uses the OpenTelemetry API.

Read the following instructions to learn how to migrate to the Splunk Ruby OTel agent.

Compatibility and requirements

The Splunk Distribution of OpenTelemetry Ruby requires Ruby 2.5 and higher. See OpenTelemetry Ruby compatibility and requirements.

Migrate to the Splunk Distribution of OpenTelemetry Ruby

To migrate from the SignalFx Tracing Library for Ruby to the Splunk Distribution of OpenTelemetry Ruby, follow these steps:

  1. Remove the tracing library packages. See Remove the SignalFx Tracing Library for Ruby.

  2. Deploy the Splunk Distribution of OpenTelemetry Ruby. See Deploy the Splunk Ruby agent.

  3. Migrate your existing configuration. See Migrate settings for the Splunk Ruby OTel agent.

Note: Semantic conventions for span names and attributes change when you migrate. For more information, see Migrate from SignalFx Smart Agent to the Splunk Distribution of OpenTelemetry Collector.

Remove the SignalFx Tracing Library for Ruby

Follow these steps to remove the tracing library and its dependencies:

  1. Uninstall signalfx:

    gem uninstall signalfx

  2. Remove signalfx from your Gemfile.

  3. Remove any additional OpenTracing instrumentation packages you installed.

Deploy the Splunk Ruby agent

To install the Splunk Distribution of OpenTelemetry Ruby, see Instrument your Ruby application for Splunk Observability Cloud.

Migrate settings for the Splunk Ruby OTel agent

To migrate settings from the SignalFx tracing library to the Splunk Distribution of OpenTelemetry Ruby, rename the following environment variables:

SignalFx environment variable

OpenTelemetry environment variable

SIGNALFX_ACCESS_TOKEN

SPLUNK_ACCESS_TOKEN

SIGNALFX_SERVICE_NAME

OTEL_SERVICE_NAME

SIGNALFX_ENDPOINT_URL

OTEL_EXPORTER_JAEGER_ENDPOINT or OTEL_EXPORTER_OTLP_ENDPOINT

SIGNALFX_RECORDED_VALUE_MAX_LENGTH

SPLUNK_MAX_ATTR_LENGTH

For more information about Splunk Ruby OTel settings, see Configure the Ruby agent for Splunk Observability Cloud.

Log injection changes

To inject tracing metadata into log statements, see Connect Ruby trace data with logs for Splunk Observability Cloud.