設定方法

Splunk Distribution of OpenTelemetry JS を設定するには、環境変数と start() 関数に渡す引数を組み合わせて使用します：

• 環境変数

  例： export OTEL_SERVICE_NAME='test-service'

• start() 関数に渡される引数

  例： start({ serviceName: 'my-node-service', });

メトリクススやトレースなど、サポートされている各データ・タイプのコンフィギュレーションは、コンフィギュレーション・オブジェクトの追加プロパティを使用して設定します：

start({
   // general options like `serviceName` and `endpoint`
   metrics: {
      // configuration passed to metrics signal
   },
   profiling: {
      // configuration passed to profiling signal
   },
   tracing: {
      // configuration passed to tracing signal
   },
});

オブジェクトの代わりにブーリアン値を渡すことで、特定のデータ型の収集をアクティブにすることもできます。例：

start({
   // general options like `serviceName` and `endpoint`
   metrics: true, // turn metrics on with default options
   profiling: true, // turn profiling on with default options
});

一般設定

以下の設定は、Splunk Distribution of OpenTelemetry JS 固有のものです：

インストルメンテーション構成

以下の設定は、どのインストルメンテーションをアクティブにするかを制御します：

たとえば、デフォルトのインストルメンテーションをすべてオフにし、bunyan インストルメンテーションだけをオンにするには、以下の環境変数を設定します：

export OTEL_INSTRUMENTATION_COMMON_DEFAULT_ENABLED=false
export OTEL_INSTRUMENTATION_BUNYAN_ENABLED=true

前の設定は、デフォルトで Splunk Distribution of OpenTelemetry JS によってロードされたインストルメンテーションにのみ適用されます。プログラム API を使用してユーザー指定のインストルメンテーションのリストを提供する場合、以前の設定は効果がありません。

トレース設定

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

サンプラーの設定

以下の設定はトレースサンプリングをコントロールします：

エクスポーターの設定

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

Jaeger エクスポーター

Jaeger エクスポーターを使うには、以下の例のように @opentelemetry/exporter-jaeger パッケージを追加します：

const { start } = require('@splunk/otel');
const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
start({
   serviceName: 'my-node-service',
   tracing: {
      spanExporterFactory: (options) => {
      return new JaegerExporter({
         serviceName: options.serviceName,
         // Additional config
      })
      }
   },
});

プロパゲータの構成

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

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

Linux

export OTEL_PROPAGATORS=b3multi

Windows PowerShell

$env:OTEL_PROPAGATORS=b3multi

AlwaysOn Profilingの Node.js 設定

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

プログラムで AlwaysOn Profilingを設定するには、次の例のように start 関数に引数を渡します：

start({
   serviceName: '<service-name>',
   profiling: true,
   tracing: {
      // configuration passed to tracing signal
   },
});

メトリクスの設定

以下の設定は、ランタイム・メトリクスの収集を有効にします：

既存のメトリクス・クライアントを設定してカスタムメトリクスを送信する

カスタムメトリクスの送信には、新しいクライアントを作成して設定する代わりに、既存のSignalFxクライアントを使用できます。

既存のクライアントを設定するには、start() 関数に以下のデータを渡します：

• signalfx：オプションの client および dimensions フィールドを持つ Javascript オブジェクト。 dimensions オブジェクトは、各データポイントに事前定義されたディメンションを追加します。dimensions の形式は {key: value, ...} です。

以下は、デフォルトで追加されるディメンションのリストです：

• service：「トレース設定」の「serviceName」を参照してください。

• metric_source： splunk-otel-js

• node_version: process.versions.node 例えば 16.10.0

サーバートレース情報

モバイルおよび Web アプリケーションからのリアルユーザーモニタリング(RUM) リクエストをサーバーのトレースデータに接続するには、以下の環境変数を設定して Splunk のトレース・レスポンス・ヘッダーを有効にします：

Linux

export SPLUNK_TRACE_RESPONSE_HEADER_ENABLED=true

Windows PowerShell

$env:SPLUNK_TRACE_RESPONSE_HEADER_ENABLED=true

この環境変数を設定すると、アプリケーション・インストルメンテーションはHTTPレスポンスに以下のレスポンス・ヘッダーを追加します。

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

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