SignalFx Tracing Library for Pythonからの移行

Splunk Distribution of OpenTelemetry Python のエージェントは、非推奨の SignalFx Python Tracing Library に代わるものです。Splunk Python OTel エージェントに移行するには、次の手順に従います。

SignalFx Tracing Library for Python は非推奨であり、2022 年 12 月 17 日にサポート終了となります。Splunk Distribution of OpenTelemetry Python のエージェントに置き換えてください。

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

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

互換性と要件

Splunk Distribution of OpenTelemetry Python には Python 3.7 以上が必要です。 「Python エージェントの互換性と要件」を参照してください。

Splunk Distribution of OpenTelemetry Python への移行

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

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

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

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

  4. Python サービスまたはアプリケーションを起動します。「Start you Python application after completing the migration」を参照してください。

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

SignalFx Tracing Library for Pythonの削除

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

  1. signalfx-tracing をアンインストールします：

    pip uninstall signalfx-tracing

  2. requirements.txtまたはpyproject.tomlファイルから signalfx-tracing を削除します。

  3. パッケージマネージャが signalfx-tracing の依存関係をすべて削除していない場合は、手動で削除してください。

    pip uninstall opentracing
pip uninstall jaeger-client

  4. sfx-py-trace-bootstrap コマンドでインストールされたすべてのインストルメンテーション・パッケージを削除します。

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

Djangoアプリケーションの追加手順

Splunk Distribution of OpenTelemetry Python では、INSTALLED_APPS に何も追加する必要はありません。

以下の手順に従って、Django の設定を更新してください：

  1. settings.py の INSTALLED_APPS から signalfx_tracing を削除します。

  2. 環境変数 DJANGO_SETTINGS_MODULE に manage.py または wsgi.py と同じ値を設定します。

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

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

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

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

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 Python OTel 設定の詳細については、「Configure the Python agent for Splunk Observability Cloud」を参照してください。

マイグレーション完了後、Pythonアプリケーションを起動します。

splunk-py-trace を使用して Python アプリケーションまたはサービスを実行します。たとえば、python main.py を使ってサービスを実行する場合、splunk-py-trace python main.py を使って実行することで、自動的にインストルメンテーションを行うことができます。詳しくは、「Python アプリケーションを Splunk Observability Cloud にインストルメンテーションする」を参照してください。

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

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