Node.js設定参考資料

このページでは、Node.js エージェントの構成に使用できる設定について説明します。

いくつかの設定に環境変数を使用することもできます。設定を適用するには、モニタリング対象アプリケーションの Node.js エージェントの require ステートメントにそれらを追加します。

Node.js エージェントはバージョン 21.9 以降、プロキシをサポートしなくなりました。

一般設定

以下はアプリケーションコードに挿入するrequireステートメントにある設定の完全なリストです。これらのすべての設定が必要なわけではありません。

分析の設定

デフォルトのトランザクションデータを分析エージェントに送信するように Node.js エージェントを構成できます。

分析のホストとポートの設定を次の形式で追加する場合、ホストとポート番号を指定します。分析エージェントは、Node.js エージェントと同じか、または異なるホストおよびポート番号について報告できます。

analytics: {
    host: <analyticsHostName>,
    port: <analyticsPort>,
    ssl: <true || false>  
}

分析データの制限を設定するには、「Node.js および PHP アプリケーション用のトランザクション分析の設定」を参照してください。

Windows 設定

Windows で、Node.js エージェントは追加のポートを 3 つ要求します。

• proxyCommPort：デフォルトは 10101
• proxyRequestPort：デフォルトは 10102
• proxyReportingPort：デフォルトは 10103

詳細については、「Windows での Node.js エージェントの実行」を参照してください。


機密データのフィルタ

アプリケーションにコントローラに表示すべきではない機密データが含まれている場合は、Node.js エージェントの require ステートメントに次のデータフィルタを適用できます。

機密データフィルタを追加する

機密データフィルタを有効にすると、コントローラは一致する環境変数またはシステムプロパティの値に対してアスタリスクを表示します。

dataFilters: [{
   "appliesTo": "http-headers",
   "matchPattern": "host"
}],

環境変数フィルタ

デフォルトでは、Node.js エージェントは、大文字と小文字を区別しない部分文字列「password|key」を含む環境変数またはシステムプロパティを使用して機密データフィルタを有効にします。

dataFilters: [{
   "appliesTo": "env-vars",
   "matchPattern": "password|key"
}],

機密 URL フィルタ

機密 URL フィルタを使用して、[Transaction Snapshot] の詳細で URL の機密情報を難読化するようにエージェントを構成できます。

urlFilters: [{
   "delimiter": "/",
   "segment": "1",
   "matchPattern": "a",
   "paramPattern": "bar"
}],

機密 URL フィルタは、1 つのセグメントで matchPattern をチェックします。追加のセグメントを確認するには、追加の JSON 配列を追加します。

フィルタは、/aa/bb/cc → ***/bb/cc の形式で要求を処理します。 

matchpattern/parampattern は標準の正規表現です。

urlFilters

delimiter

segment

URL セグメントフィルタ

matchpattern 正規表現を使用して、Node.js エージェントは指定されたセグメントをフィルタ処理するかどうかを決定します。

複数のルールがある場合は、一般性の高いルールの前に、具体性の高いルールをリストします。配列にリストされているルールは、順序に基づいて評価されます。  

ルール A：

{
 'delimiter': '/',
 'matchPattern': '[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}\/.{50,}',
 'segment': '3,5'
}

ルール B：

{
 'delimiter': '/',
 'matchPattern': '[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}',
 'segment': '3'
}

この例では、最初のルール A は 3 番目と 5 番目のセグメントをマスクするため、ルール B の前にルール A をリストする必要があります。

ルール B がルール A の前にリストされて評価された場合、3 番目のセグメントはマスクされますが、5 番目のセグメントはマスクされず、機密情報が漏洩する可能性があります。 

URL パラメータフィルタ

paramPattern 正規表現を使用して、Node.js エージェントは指定されたクエリパラメータをフィルタ処理するかどうかを決定します。 

すべての URL パラメータをマスクする必要がある場合は、さらに指示を配列に追加できます。

{ "delimiter": "/", "matchPattern": "", "segment": "99", "paramPattern": ".+"}

Node.js エージェントは、すべての URL パラメータをフィルタで除外します。 

機密メッセージフィルタ

機密メッセージフィルタを使用して、エージェントがログメッセージから収集したテキストメッセージ、または例外からの詳細メッセージに含まれる機密情報を難読化するようにエージェントを構成できます。

messageFilters: [{
   "messageType": 
"throwable",
   "matchPattern": 
"Error.*MySQL.",
   "redactionRegex": "SQL"
}]

環境変数

requireステートメントで必要な設定を指定していない場合、エージェントは以下の環境設定の値を使用します（すでにその変数が設定済みの場合）。両方が設定されている場合、require ステートメントの値が環境変数より優先されます。

環境変数	へのマップ
APPDYNAMICS_CONTROLLER_HOST_NAME	controllerHostName
APPDYNAMICS_CONTROLLER_PORT	controllerPort
APPDYNAMICS_CONTROLLER_SSL_ENABLED	controllerSslEnabled
APPDYNAMICS_AGENT_ACCOUNT_NAME	accountName
APPDYNAMICS_LOGGER_OUTPUT_TYPE	値を console に設定することで、stdout にログをストリーミングできます。
APPDYNAMICS_LOGGER_LEVEL	エージェントのログレベルを設定できます。 可能な値は FATAL、ERROR、WARN、INFO、DEBUG、および TRACE です。
APPDYNAMICS_AGENT_ACCOUNT_ACCESS_KEY	accountAccessKey
APPDYNAMICS_AGENT_APPLICATION_NAME	applicationName
APPDYNAMICS_AGENT_TIER_NAME	tierName
APPDYNAMICS_AGENT_NODE_NAME	nodeName
APPDYNAMICS_AGENT_UNIQUE_HOST_ID
APPDYNAMICS_ANALYTICS_HOST_NAME	host（Analytics 設定内）
APPDYNAMICS_ANALYTICS_PORT	port（Analytics 設定内）
APPDYNAMICS_ANALYTICS_SSL_ENABLED	ssl（Analytics 設定内）
UNIQUE_HOST_ID	uniqueHostId 一意のホスト ID は、ホストを識別する任意の値に設定できます。値を指定しない場合、エージェントによってホスト ID が生成されます。 この環境変数はデフォルトで使用できます（Java プロキシモードでは使用できません）。