SignalFx Tracing Library for Ruby からの移行

Splunk Distribution of OpenTelemetry Ruby のエージェントは、廃止の SignalFx Ruby トレースライブラリを置き換えるものです。Splunk Ruby OTel エージェントに移行するには、以下の指示に従ってください。

SignalFx Ruby トレースライブラリは廃止され、2023 年 9 月 30 日にサポートが終了しました。Splunk Distribution of OpenTelemetry Ruby のエージェントに置き換えてください。

Splunk Distribution of OpenTelemetry Ruby は、OpenTelemetry API を使用するオープンソースプロジェクトである OpenTelemetry Instrumentation for Ruby に基づいています。

Splunk Ruby OTel エージェントへの移行方法については、以下の説明をお読みください。

互換性と要件

Splunk Distribution of OpenTelemetry Ruby には Ruby 2.5 以上が必要です。「OpenTelemetry Ruby の互換性と要件」を参照してください。

Splunk Distribution of OpenTelemetry Ruby への移行

SignalFx Tracing Library for Ruby から Splunk Distribution of OpenTelemetry Ruby へ移行するには、以下の手順に従ってください:

  1. トレースライブラリのパッケージを削除します。「Ruby の SignalFx トレースライブラリを削除する」を参照してください。

  2. Splunk Distribution of OpenTelemetry Ruby をデプロイします。「Splunk Ruby エージェントをデプロイする」を参照してください。

  3. 既存の設定を移行します。「Splunk Ruby OTel エージェントの設定を移行する」を参照してください。

注: 移行の際、スパン名と属性の意味上の規約が変更されます。詳細については、「SignalFx Smart Agent から Splunk Distribution of OpenTelemetry Collector への移行」を参照してください。

SignalFx Tracing Library for Ruby の削除

以下の手順に従って、トレース・ライブラリとその依存関係を削除してください:

  1. signalfx をアンインストールします:

    gem uninstall signalfx
  2. Gemfileから signalfx を削除します。

  3. 追加でインストールした OpenTracing のインストルメンテーション・パッケージをすべて削除します。

Splunk Ruby エージェントをデプロイする

Splunk Distribution of OpenTelemetry Ruby をインストールするには、「Splunk Observability Cloud に Ruby アプリケーションをインストルメンテーションする」を参照してください。

Splunk Ruby OTel エージェントの設定を移行する

SignalFx トレース・ライブラリから Splunk Distribution of OpenTelemetry Ruby に設定を移行するには、以下の環境変数の名前を変更します:

SignalFx 環境変数

OpenTelemetry環境変数

SIGNALFX_ACCESS_TOKEN

SPLUNK_ACCESS_TOKEN

SIGNALFX_SERVICE_NAME

OTEL_SERVICE_NAME

SIGNALFX_ENDPOINT_URL

OTEL_EXPORTER_JAEGER_ENDPOINT または OTEL_EXPORTER_OTLP_ENDPOINT

SIGNALFX_RECORDED_VALUE_MAX_LENGTH

SPLUNK_MAX_ATTR_LENGTH

Splunk Ruby の OTel 設定の詳細については、「Splunk Observability Cloud の Ruby エージェントを設定する」を参照してください。

ログ・インジェクションの変更

ログステートメントにトレースメタデータを挿入するには、「Ruby トレースデータを Splunk Observability Cloud のログと接続する」を参照してください。