Node.js アプリケーションのトレース
セキュリティモニタリングが使用可能です セキュリティモニタリングが使用可能です

Node.js アプリケーションのトレース

互換性要件

NodeJS トレーサーはバージョン 8 以降を公式にサポートします。8.x や 10.x など、偶数バージョンのみが公式なサポート対象です。9.x や 11.x などの奇数バージョンは動作しますが、公式なサポート対象ではありません。サポートするライブラリの一覧については、互換性要件ページをご覧ください。

インストールと利用開始

すでに Datadog アカウントをお持ちの場合は、ホストベースまたはコンテナベースのセットアップ向けのアプリ内ガイドで詳細な手順をご確認いただけます。

APM で使用される用語の説明は、公式ドキュメントを参照してください。

コンフィギュレーションおよび API の使用の詳細については、Datadog の API ドキュメントを参照してください。

貢献の詳細については、開発ガイドを参照してください。

Quickstart

このライブラリは、インスツルメントされたいずれのモジュールよりも先にインポートおよび初期化する必要があります。トランスパイラーを使用する時は、トレーサーライブラリを外部ファイルにインポートして初期化する必要があります。その後、アプリケーションを構築する際にそのファイルをまとめてインポートします。これにより、ホイストを防ぎ、他のモジュールがインポートされる前にトレーサーライブラリを確実にインポートして初期化します。

Node.js アプリケーションのトレースを開始するには、まず Datadog Agent をインストールおよび構成し、次に Docker アプリケーションのトレースまたは Kubernetes アプリケーションに関する追加ドキュメントを確認します。

次に、以下の npm を使用して Datadog Tracing ライブラリをインストールします。

npm install --save dd-trace

最後に、トレーサーをインポートして初期化します。

JavaScript
// この行は、インスツルメントされたいずれのモジュールのインポートより前である必要があります。
const tracer = require('dd-trace').init();
TypeScript
// server.ts
import './tracer'; // インスツルメントされたいずれのモジュールのインポートより前である必要があります。

// tracer.ts
import tracer from 'dd-trace';
tracer.init(); // ホイストを避けるため異なるファイルで初期化。
export default tracer;

初期化のオプションについては、トレーサー設定を参照してください。

構成

トレーサーの設定は、パラメーターを init() メソッドとして、または環境変数として構成できます。

タグ付け

構成環境変数デフォルト説明
envDD_ENVnullアプリケーションの環境 (例: prodpre-prodstage) を設定します。バージョン 0.20 以降で利用可能。
サービスDD_SERVICEnullこのプログラムで使用するサービス名。バージョン 0.20 以降で利用可能。
versionDD_VERSIONnullアプリケーションのバージョン番号。デフォルトは、package.json のバージョンフィールドの値です。バージョン 0.20 以降で利用可能。
tagsDD_TAGS{}すべてのスパンおよびメトリクスに適用されるべきグローバルタグを設定します。環境変数として渡される場合、フォーマットは key:value, key:value となります。バージョン 0.20 以降で利用可能。

サービスに envserviceversion を設定するには、DD_ENVDD_SERVICEDD_VERSION を使用することをおすすめします。このような環境変数の構成におすすめの方法については、統合サービスタグ付けのドキュメントをご参照ください。

インスツルメンテーション

構成環境変数デフォルト説明
enabledDD_TRACE_ENABLEDtrueトレーサーを有効にするかどうか。
debugDD_TRACE_DEBUGfalseトレーサーでデバッグロギングを有効化します。
urlDD_TRACE_AGENT_URLnullトレーサーが送信するトレース Agent の URL。設定した場合、ホスト名およびポートより優先されます。datadog.yaml ファイルの apm_config.receiver_socket または DD_APM_RECEIVER_SOCKET 環境変数と組み合わせて、Unix ドメインソケットをサポートします。
hostnameDD_TRACE_AGENT_HOSTNAMElocalhostトレーサーが送信する Agent のアドレス。
portDD_TRACE_AGENT_PORT8126トレーサーが送信するトレース Agent のポート。
dogstatsd.portDD_DOGSTATSD_PORT8125メトリクスが送信される DogStatsD Agent のポート。
logInjectionDD_LOGS_INJECTIONfalse対応するログライブラリのログにトレース ID の自動挿入を有効にします。
sampleRate-1スパンのサンプリング率: 01 間の浮動小数点。
flushInterval-2000トレーサーが Agent へトレースを送信する際のインターバル (ミリセカンド)。
runtimeMetricsDD_RUNTIME_METRICS_ENABLEDfalseランタイムメトリクスのキャプチャを有効にするかどうか。ポート 8125 (または dogstatsd.port で構成) が UDP 用に Agent で開いている必要があります。
experimental-{}試験機能は、 Boolean の true を使用して一度に、またはキー/値のペアを使用して個々に有効にできます。試験機能に関する詳細は、[サポート][10]までお問い合わせください。
plugins-trueビルトインプラグインを使用して、外部ライブラリの自動インスツルメンテーションを有効にするかどうか。
-DD_TRACE_DISABLED_PLUGINS-トレーサーが初期化された際に自動で無効となるインテグレーション名のカンマ区切り文字列。DD_TRACE_DISABLED_PLUGINS=express,dns などの環境変数のみとなります。
clientTokenDD_CLIENT_TOKENnullブラウザーのトレーシング用クライアントトークン。Datadog の Integrations -> APIs で生成できます。
logLevelDD_TRACE_LOG_LEVELdebugデバッグロギングが有効な場合に使用する、トレーサーの最小ログレベル用ストリング (例: error, debug)。

Agent ホスト名の変更

アプリケーションレベルのトレーサーを設定し、以下のカスタム Agent ホスト名にトレースを送信します。

Nodejs racing Module が自動的に検索し環境変数の DD_AGENT_HOSTDD_TRACE_AGENT_PORT で初期化します。

DD_AGENT_HOST=<HOSTNAME> DD_TRACE_AGENT_PORT=<PORT> ノードサーバー

UDS などの異なるプロトコルを使用するには、URL 全体を単一の環境変数 DD_TRACE_AGENT_URL として指定します。

DD_TRACE_AGENT_URL=unix:<SOCKET_PATH>ノードサーバー

その他の参考資料