Splunk Observability Cloud 用の Python エージェントを設定する

Splunk Distribution of OpenTelemetry Python のエージェントを設定することで、トレースとログの関連付けや、エクスポーターの有効化など、ほとんどのインストルメンテーションニーズに対応できます。

Splunk Distribution of OpenTelemetry Python の Python エージェントを、インストルメンテーションのニーズに合わせて設定することができます。ほとんどの場合、基本設定を調整するだけで開始するには十分です。

以下のセクションでは、OpenTelemetry Python の Splunk ディストリビューション独自の新機能を有効にするオプションを含め、Python エージェントを設定するために利用可能なすべての設定について説明します。

一般設定

以下の設定は、OpenTelemetry Python の Splunk ディストリビューション固有のものです：

環境変数

説明

SPLUNK_ACCESS_TOKEN

エクスポータがデータを Splunk Observability Cloud に直接送信するための Splunk 認証トークン。デフォルトでは設定されていません。Splunk Observability Cloud の取り込みエンドポイントにデータを送信する必要がある場合を除き、必要ありません。「Splunk Observability Cloud を使用して認証トークンを作成および管理する」を参照してください。

SPLUNK_TRACE_RESPONSE_HEADER_ENABLED

HTTP レスポンスヘッダーへのサーバートレース情報の追加を有効にします。詳細については、「サーバートレース情報」を参照してください。デフォルト値は true です。

OTEL_METRICS_ENABLED

メトリクスコレクションを有効にします。デフォルト値は true です。詳しくは、「OpenTelemetry Python の Splunk ディストリビューションによって収集されたメトリクスと属性」を参照してください。

SPLUNK_REALM

 組織のレルムの名前（us0 など）。レルムを設定すると、テレメトリは Splunk Distribution of OpenTelemetry Collector をバイパスして、Splunk Observability Cloud のインジェストエンドポイントに直接送信されます。

トレース設定

以下の設定は、トレースの制限と属性を制御します：

環境変数

説明

OTEL_TRACE_ENABLED

トレーサの作成と自動インストルメンテーションを有効にします。デフォルト値は true です。

OTEL_SERVICE_NAME

インストルメンテーションしているサービスまたはアプリケーションの名前。 OTEL_RESOURCE_ATTRIBUTES 変数で定義されたサービス名よりも優先されます。

OTEL_RESOURCE_ATTRIBUTES

報告されたスパンごとに追加されるリソース属性のカンマ区切りリスト。たとえば、key1=val1,key2=val2 のようになります。

OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT

スパンごとの属性の最大数。デフォルト値は [無制限] です。

OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT

イベントあたりの属性の最大数。デフォルト値は [無制限] です。

OTEL_LINK_ATTRIBUTE_COUNT_LIMIT

リンクごとの属性の最大数。デフォルト値は [無制限] です。

OTEL_SPAN_EVENT_COUNT_LIMIT

スパンあたりの最大イベント数。デフォルト値は [無制限] です。

OTEL_SPAN_LINK_COUNT_LIMIT

スパンあたりの最大リンク数。デフォルト値は 1000 です。

OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT

属性値の文字列の最大長。上限より大きい値は切り捨てられます。デフォルト値は 1200 です。

エクスポーターの設定

以下の設定は、トレースエクスポーターとそのエンドポイントをコントロールします：

環境変数

説明

OTEL_TRACES_EXPORTER

使用するエクスポータを追跡します。複数のカンマ区切り値を設定できます（otlp, console など）。デフォルト値は otlp です。

OTEL_METRICS_EXPORTER

使用するメトリクスエクスポータ。デフォルト値は otlp です。許容値は otlp および none です。 none を設定すると、メトリクスのエクスポートが非アクティブになります。

OTEL_METRIC_EXPORT_INTERVAL

2 回のエクスポートの開始間隔（ミリ秒単位）。デフォルト値は 60000 です。

OTEL_METRIC_EXPORT_TIMEOUT

データのエクスポートに許容される最大時間（ミリ秒単位）。デフォルト値は 30000 です。

OTEL_EXPORTER_OTLP_ENDPOINT

OTLP エンドポイント。デフォルト値は http://localhost:4317 です。

OTEL_EXPORTER_OTLP_METRICS_ENDPOINT

OTLP エンドポイント。デフォルト値は http://localhost:4317 です。

Collector をバイパスして Splunk Observability Cloud に直接データを送信するには、「Splunk Observability Cloud にデータを直接送信する」を参照してください。

プロパゲータの構成

以下の設定はトレース伝搬をコントロールします：

環境変数

説明

OTEL_PROPAGATORS

使用するプロパゲータのカンマ区切りリスト。デフォルト値は tracecontext,baggage です。サポートされているプロパゲータのリストは、OpenTelemetry のドキュメントで確認できます。

SignalFx Python Tracing Libraryとの後方互換性のために、b3multiトレースプロパゲータを使用してください：

Linux
SHELL 
export OTEL_PROPAGATORS=b3multi
Windows PowerShell
SHELL 
$env:OTEL_PROPAGATORS=b3multi

AlwaysOn Profiling の Python 設定

注: CPU プロファイリングのみサポートされています。

以下の設定は、Python エージェントの AlwaysOn Profiling 機能を制御します：

環境変数

説明

SPLUNK_PROFILER_ENABLED

AlwaysOn Profiling を有効化します。デフォルト値は false です。

SPLUNK_PROFILER_LOGS_ENDPOINT

プロファイラログのコレクタエンドポイント。デフォルトでは、http://localhost:4317 の値をとります。

SPLUNK_PROFILER_CALL_STACK_INTERVAL

コールスタックサンプリングの頻度（ミリ秒単位）。デフォルト値は 1000 です。

SPLUNK_PROFILER_INCLUDE_INTERNAL_STACKS

内部プロファイラのスレッドからのスタックトレースを含めるかどうかを決定します。デフォルト値は false です。

サーバートレース情報

モバイルおよびウェブアプリケーションからの Real User Monitoring（RUM）リクエストとサーバートレースデータを接続するために、トレース レスポンス ヘッダーがデフォルトで有効になっています。インストルメンテーションは、HTTP レスポンスに以下のレスポンスヘッダーを追加します。

DEFAULT 
Access-Control-Expose-Headers: Server-Timing
Server-Timing: traceparent;desc="00-<serverTraceId>-<serverSpanId>-01"

Server-Timing ヘッダーには traceId と spanId パラメータが traceparent 形式で含まれます。詳しくは、W3C Web サイトの Server-Timing と traceparent のドキュメントを参照してください。

注: トレース・レスポンス・ヘッダーを無効にする必要がある場合は、SPLUNK_TRACE_RESPONSE_HEADER_ENABLED を false に設定します。

コード内でPythonエージェントを設定する

環境変数を設定できない場合、または実行時に splunk-py-trace を使用して設定値を設定できない場合は、コードで設定を定義します。

「Splunk Observability Cloud 用の Python アプリケーションを手動でインストルメンテーションする」を参照してください。