Node.js コレクターの設定

コレクターは IP 127.0.0.1 を使用して、ホストのデフォルト・ゲートウェイを介したフォールバックとして Instana エージェントと通信しようとします。 これらの IP のいずれでもエージェントを使用できない場合は、agentHost オプションを使用してカスタム IP を使用することができます。

require('@instana/collector')({
  agentHost: '::1' // use IPv6 to contact via localhost
});
 

あるいは、環境変数を利用します。

require('@instana/collector')({
  agentHost: process.env.HOST_IP
});
 

構成されていない場合、Instana コレクターは INSTANA_AGENT_HOST という名前の環境変数を検索し、この環境変数で定義されている内容を使用してエージェントと通信します。 この環境変数がない場合は、まず localhost でエージェントとの接続を試行し、次にデフォルト・ゲートウェイで接続を試行します。

コレクターはポート 42699 を介して Instana エージェントとの通信を試行します。 ポートが変更されている場合は、agentPortオプションを使用してポートを変更できます。

require('@instana/collector')({
  agentPort: 42699
});
 

構成されていない場合、Instana コレクターは INSTANA_AGENT_PORT という名前の環境変数を検索し、この環境変数で定義されている内容を使用してエージェントと通信します。 この環境変数がない場合は、デフォルト・ポート 42699 にフォールバックします。

Node.js アプリケーションと Instana エージェントが Kubernetes クラスタで実行されている場合、この構成に必要な設定については、 Kubernetes ネットワークアクセスに関するドキュメントを参照してください。

Instana エージェントが存在する非サーバーレス環境では、 Node.js トレーサーは、実行中の Node.js バージョンがサポート終了（EOL）に達したことを検出すると、問題イベントをトリガーします。

これらのEOLイベントを抑制するには、次の環境変数を使用して無効化できます:

INSTANA_TRACING_DISABLE_EOL_EVENTS=true
 

Node.js のEOL（サポート終了）バージョンの完全な一覧については、公式の Node.js リリースページを参照してください。

デフォルトでは、 InstanaNode.js トレーサーは、アクティブなエントリースパンを持つ出口スパンのみをキャプチャします。 この機能を有効にすると、トレーサーがスタンドアロンの終了スパンを追跡できるようになります。

この機能を有効にするには、以下のいずれかのオプションを使用してください：

• 環境 INSTANA_ALLOW_ROOT_EXIT_SPAN 変数を設定する。

• Tracerの初期化関数を通じて機能を設定します：

  require('@instana/collector')({
  tracing: {
    allowRootExitSpan: true
  }
  });
   

が または 1 に設定 INSTANA_ALLOW_ROOT_EXIT_SPAN されている場合、 trueあるいは allowRootExitSpan が に設定されている場合 true、アクティブなエントリ スパンが存在しない場合でも、トレーサーは終了スパンをキャプチャします。

この機能は、 Instana の自動計測ではサポートされていないメカニズムによってタスクがトリガーされる以下のシナリオで有用です：

• 非対応のメッセージングライブラリからの受信メッセージ
• サポートされていないプロトコル（例：生の Transmission Control Protocol （ TCP ）や WebSocket ）を介して行われるリクエスト
• アプリケーションが内部的に開始するスケジュールされたジョブ（ Node.js などのメカニズム setTimeout、 setIntervalまたは非サポートのスケジューリングライブラリを使用する場合を含む）

Node.js Tracer 4.9.0 から開始し、特定のトレースや呼び出しを除外することで、不要なデータ取り込みを削減できます。 このフィルタリング機構はトレース収集を洗練させます。 トレースを除外するには、 Node.js のトレース設定で以下のパラメータを定義してください：

• 技術：関連する技術を指定してください。例：、 Kafka Redis、 DynamoDB、、または HTTP。
• 方法：除外すべき方法を特定する。 例えば、以下の技術についてはこれらのメソッドを除外します：
  • Kafka: send, consume
  • Redis: get, type
  • DynamoDB: query, scan
  • HTTP: get, post
• エンドポイント（該当する場合）：特定のエンドポイントに基づいてフィルタリングをさらに絞り込みます。 例えば、以下の技術のエンドポイントは次のように定義されています：
  • Kafkaエンドポイントはトピック名です。
  • HTTPエンドポイントは URL のパスです。
• 接続（オプション）：特定の接続のトレースを除外します。 例えば、以下の技術に対する接続は次のように定義されます：
  • Redis接続は接続文字列です。
  • HTTP接続にはホストとポートが含まれます。

トレースを無効にするには、完全にオフにするか、特定の計測項目やデータベース、メッセージング、ロギングなどのグループ全体を選択的に除外することができます。 この柔軟性により、アプリケーションのニーズに基づいてトレースを微調整できます。

トレースを無効にする設定を適用するには、次のいずれかの方法を使用します：

• 環境変数
• コード内設定
• エージェント設定（ YAML ）

自動トレースもデフォルトで有効になっています。 自動トレースのみを無効にする (SDK またはopenTracing による手動トレースは有効にしておく) には、次のオプションを初期化関数に渡します。

require('@instana/collector')({
  tracing: {
    automaticTracingEnabled: false
  }
});
 

最後に、環境変数 INSTANA_DISABLE_AUTO_INSTR=true を設定することでも自動トレースを無効にすることができます。

自動トレースが無効化されていても、SDK または OpenTracing API を使用してスパンを手動で作成することはできます。

OpenTelemetry の統合はデフォルトで有効になっています。 統合を無効化するには、初期化関数に次のオプションを渡してください：

require('@instana/collector')({
  tracing: {
    useOpentelemetry: false
  }
});
 

さらに、変 INSTANA_DISABLE_USE_OPENTELEMETRY 数を に設定することで true、 OpenTelemetry の統合を無効にできます。 詳細については、 Instana 環境変数を参照してください。

Instana の Node.js コレクターがワーカースレッドを追跡しないようにするには、次の環境変数を設定します:

INSTANA_DISABLE_WORKER_THREADS=true

この設定では、すべてのワーカースレッドのトレースが無効化されますが、メインプロセスは自動的にトレースされます。 ワーカースレッドが内部タスクやバックグラウンドタスクを実行し、それらをトレース対象から除外したい場合にこの設定を使用してください。

デフォルトでは、コレクターはキャプチャーされたエグジット・スパンごとに最新の 10 件の呼び出しサイトをキャプチャーします。 この値は必要に応じて増減できます (HTTP エントリー・スパンのスタック・トレースは収集されないことに注意してください。このトレースは Node.js コア・コードのみが表示されます)。 スタック・トレースのキャプチャーを無効にするには、値 0 を使用します。

require('@instana/collector')({
  tracing: {
    stackTraceLength: 10
  }
});
 

また、環境変数 INSTANA_STACK_TRACE_LENGTH を設定することによっても、スタック・トレースの長さを構成できます。

Instana コレクターは、プロジェクト内のプライマリ package.json ファイルを特定し、アプリケーション名などの重要な情報を抽出しようとします。 ファイル package.json のカスタムパスを定義する必要がある場合、またはコレクターがファイルを見つけられない場合は、設定オプション ` packageJsonPath` を使用できます。

require('@instana/collector')({
  packageJsonPath: 'absolute/path/to/package.json'
});
 

環境変数 INSTANA_PACKAGE_JSON_PATH `PATH`を設定することで、``ファイル package.json のパスも設定できます。

サービスは、Instana の中心となる概念です。 呼び出し、スパン、およびトレースはサービスに密接に関連しています。 デフォルトの場合、Node.js コレクターはメインの package.json ファイルの name 属性と version 属性を使用します。 サービス名をカスタマイズするには、serviceName プロパティーを構成します。

require('@instana/collector')({
  serviceName: 'shop'
});
 

環境変数 INSTANA_SERVICE_NAME を設定することでも、カスタム・サービス名を構成できます。 カスタムサービスの設定に関する詳細については、 「サービス名をグローバルに設定する」 を参照してください。

コレクターバージョン 4.x 以降、 Kafka トレース相関ヘッダーは常に` string `形式で送信され、` binary `形式のサポートは廃止されました。 詳細については、 Kafka ヘッダーの移行を参照してください。

環境変数を参照 INSTANA_KAFKA_HEADER_FORMAT する設定と、コード内の設定オプションをすべて削除してください tracing: { kafka: { headerFormat: .... }}}。

デフォルトのログ・レベルを変更するには、以下を使用して構成できます。

require('@instana/collector')({
  level: 'debug'
});
 

環境変数 INSTANA_LOG_LEVEL を debug、info、warn または error のいずれかに設定することでも、ログ・レベルを構成できます。 最後に INSTANA_DEBUG を空ではない文字列に設定すると、ログ・レベルが debug に設定されます。

デフォルトのログ・レベルは infoであることに注意してください。 予期しない Instana 関連のデバッグログ（``や`` "name":"@instana/collector""level":20 を含むログ行）を確認した場合、設定でログレベルがデバッグに設定されていないか、` INSTANA_LOG_LEVEL=debug `または INSTANA_DEBUG ``が設定されていないかを確認してください。 独自のロガーを提供する場合（以下を参照）、そのロガーのログレベルを必要に応じて設定する責任はあなたにあります。

ロガーの設定を参照してください。