Node.jsエージェントの設定

設定ファイル (newrelic.js) には、すべてのNode.jsエージェント設定が含まれています。Node.jsエージェントをインストールする際、newrelic.jsをアプリケーションのルートディレクトリにコピーする必要があります。ほとんどの設定のデフォルト値は空で、config/default.jsからの値を継承します。

newrelic.jsのほとんどのコンフィグレーション設定には同等の環境変数が含まれています。これらは、PaaS環境（Heroku、Microsoft Azureなど）でエージェントを実行する場合に役立ちます。Node.jsエージェントの環境変数は常にNEW_RELIC_で始まります。

利用可能な場合、これらの環境変数は、個々の設定オプションの下に環境変数として文書化されています。また、環境変数を介してのみ設定できる、ほとんど使用されることがない2つの設定があります。

New Relic APMとCodeStreamを使用している場合は、リポジトリを関連付ける方法と、ビルドSHAまたはリリースタグをエラー受信トレイに関連付ける方法をご覧ください。

所有者 (オーナー) と管理者は、直接New Relicでいくつかの設定を表示、設定することができます。利用可能な場合、サーバーサイドコンフィグレーション用のUIラベルは、このドキュメントの個々の設定オプションの下にサーバーサイドラベルとしてリストアップされています。

New Relicがアプリケーションを識別するのに使用する名前。例、app_name: ['MyNodeApp']。アプリケーションに複数の名前を使用するには、カンマ区切りの名前リストを指定します。

同じ名前のすべてのアプリケーションのデータはNew Relic UIにマージされるため、この設定は慎重に行ってください。当社では、混同や非意図的なデータの集計を避けるために、デフォルト名を分かりやすい名前に置き換えることを強く推奨しています。

この設定は必須です。New Relicライセンスキー。例、license_key: '40HexadecimalCharacters'。

エージェントの起動を防ぐには、falseに設定します。これは、コードをデバッグする際にエージェントを一時的に無効にする必要がある場合に役立ちます。この設定は、エージェントによってそのインストゥルメンテーションのブートストラップや、すべての要素の設定が行われることを防止し、これによりエージェントが起動しNew Relicのサーバーに接続することを阻止できます。

trueの場合、excludeルールでフィルタリングされたものを除いて、すべてのHTTPヘッダーの取得を有効にします。falseの場合、収集されたヘッダーはNode.jsエージェントの属性で定義されたものに制限されます。

Apdex TはNew Relic UIを介して設定できます。

PEM形式で文字列の配列として指定される、SSL接続に対する追加の信用証明書。これは、HTTPSプロキシとNew Relicへの両方の接続に影響します。

certificates: [ fs.readFileSync('myca.crt', {encoding: 'utf8'}) ]

trueに設定している場合、高セキュリティv2を有効にします。またssl設定を有効化し、かつUIで高セキュリティを有効化する必要があります。

インターネットに接続するためのNew Relicコレクターのホスト名（例：host: 'collector.newrelic.com'）。

タグを追加します。タグをオブジェクトとして、またはセミコロン区切りの文字列のコロンで分けられたペアとして指定します（例：Server:One;Data Center:Primary）。

New Relicコレクターに接続するためのポート番号（例：port: 443）。

インターネットに接続するためのプロキシサーバーを指定するURL。例、proxy: 'http://user:pass@10.0.0.1:8000/'。重要な考慮事項：

• proxy構成ファイル設定を使用すると、他の構成ファイルプロキシ設定（proxy_host、proxy_port、proxy_user、proxy_pass）が上書きされます。同様に、NEW_RELIC_PROXY_URL環境変数を使用すると、他の環境変数プロキシ設定（NEW_RELIC_PROXY_HOST、NEW_RELIC_PROXY_PORT``NEW_RELIC_PROXY_USER、NEW_RELIC_PROXY_PASS）が上書きされます。
• Infinite Tracingを使用している場合：Infinite Tracingのプロキシを設定する方法を参照してください。

インターネットに接続するためのプロキシサーバーのホスト名またはIPアドレス。

プロキシサーバーに対する認証用パスワード。エージェントはHTTP BASIC認証のみサポートします。

インターネットに接続するためのプロキシサーバーのポート番号。

プロキシサーバーに対する認証用ユーザー名。エージェントはHTTP BASIC認証のみサポートします。

エージェントに特異なロギングを有効または無効にします。

エージェントログに記録される詳細レベルを定義します。最小から最大の詳細レベルの順で取りうる値は、fatal、error、warn、info、debug、traceがあります。

ファイル名を含めたNew Relicエージェントログへのフルパスです。デフォルトはfilepath: require('path').join(process.cwd(), 'newrelic_agent.log')件です。エージェントは、このファイルを作成できない場合、プロセスを終了します。エージェントは、Node.jsエージェントプロセスの場合と同じアクセス権でログファイルを作成します。

• すべてのロギングをstdoutに書き込むには、これをstdoutに設定します。
• すべてのロギングをstderrに書き込むには、これをstderrに設定します。

有効な場合、エージェントはコレクターに送信するペイロードをログします。このデータは、ロギングレベルが最小レベルに設定されている場合でも、メインログファイルに含まれます。

エージェントは、さまざまなタイプのデータを個別のペイロード内のコレクターに送信します。デフォルトでは、これらすべてがログファイルに含まれています。このオプションでは、ロギングを特定のデータタイプに制限することができます。

有効な値には、次が含まれます：

• agent_settings
• analytic_event_data
• connect
• custom_event_data
• error_data
• error_event_data
• metric_data
• preconnect
• shutdown
• span_event_data
• sql_trace_data
• transaction_sample_data

このオプションで、newrelic.addCustomAttributeとnewrelic.addCustomAttributesが有効になります。

このオプションで、recordCustomEventが有効になります。

このオプションで、newrelic.noticeErrorが有効になります。

trueの場合、すべての宛先に対して属性の取得を有効にします。

すべての宛先から除外する属性のプレフィックス。末尾に*をワイルドカードとして使用可能。

すべての宛先に追加する属性のプレフィックス。末尾に*をワイルドカードとして使用可能。

trueの場合、パターンをattributes.includeリストに追加できます。

有効な場合、エージェントはアプリケーションからエラートレースを収集します。

エラーコレクターが無視するカンマ区切りのHTTPステータスコードリスト。

エラーコレクターが無視すべきjavascriptエラータイプ//クラスのカンマ区切りリスト。

以下の設定：

/* ... */
    error_collector: {
        ignore_classes: ["ReferenceError"]
    }
    /* ... */

すべての参照エラーを無視します。

javascriptオブジェクト。コレクターが無視すべきjavascriptエラーメッセージに関連したjavascriptクラスリストを説明します。以下の設定。

/* ... */
    error_collector: {
        /* ... */
        ignore_messages: {"Error":["Undefined", "Out of time"]}
        /* ... */
    }
    /* ... */

UndefinedおよびOut of timeと全く同じ（大文字と小文字を区別）メッセージ文字列を持つタイプErrorのエラーをすべて無視します。

エラーコレクターが予想済みとしてマークする、カンマ区切りのHTTPステータスコードリスト。

以下の設定：

/* ... */
    error_collector: {
        expected_classes: ["ReferenceError"]
    }
    /* ... */

すべての参照エラーを予想済みとしてマークします。

javascriptオブジェクト。コレクターが無視すべきjavascriptエラーメッセージに関連したjavascriptクラスリストを説明します。以下の設定。

/* ... */
    error_collector: {
        /* ... */
        expected_messages: {"Error":["Undefined", "Out of time"]}
        /* ... */
    }
    /* ... */

UndefinedおよびOut of timeと全く同じ（大文字と小文字を区別）メッセージ文字列を持つタイプErrorのすべてのエラーに印をつけます。

trueの場合、エージェントはエラーコレクションから属性を取得します。

エラーコレクションから除外する属性のプレフィックス。末尾に*をワイルドカードとして使用可能。

エラーコレクションに追加する属性のプレフィックス。末尾に*をワイルドカードとして使用可能。

エージェントが1分あたりに収集するイベントの最大数。この数を超える場合、エージェントは統計的サンプリングを収集します。

有効な場合、エージェントは遅いトランザクショントレースを収集します。

トランザクションを遅いクエリとトランザクショントレースの対象とするのに必要な最小クエリ時間 (ミリ秒単位)。

このオプションは、トランザクショントレースのスロークエリとrecord_sqlの両方に影響します。3つの値（off、obfuscated、raw）のいずれかにすることができまです。

offに設定されている場合、スロークエリは取得されません。また、バックトレースとSQLはトランザクショントレースに含まれません。rawまたはobfuscatedに設定されている場合、エージェントは生のSQLまたは難読化されたSQLとスロークエリのサンプルをコレクターに送信します。またエージェントは、その他の条件が満たされている場合（slow_sql.enabledが設定されているなど）、SQLを送信することがあります。

トランザクショントレースに適したリクエストの最大数を定義。

トランザクションはリクエストに基づき命名され、top_nはこうした名前でグループ化された、「最も遅いトランザクションの上位n」を意味します。モジュールが記録済みのトレースを新規トレースと置き換えるのは、新規トレースがその名前の過去のトレースの最も遅いものよりも遅い場合のみとなります。この設定のデフォルト値はtop_n: 20です。これは、トランザクションページもまた、最も遅い20のトランザクションをデフォルトとするためです。

Node.jsエージェントは、起動後の最初の収集サイクルにおいて、少なくとも5つの異なる遅いトランザクションをキャプチャーします。また、過去の5つの収集サイクルにおいて遅いトランザクションがキャプチャーされなかった場合は、リセットしてから別のトランザクションをキャプチャーします。こうして、自社のアプリのリクエストパスに関して、その収集サイクルで絶対的に遅いリクエストに注目することなく詳細を確認できるようになります。

トランザクションがトランザクショントレースの資格を持つことになる、ウェブトランザクションレスポンスタイムの閾値（秒数）。デフォルト値はapdex_fです。これによって、トレースの閾値はご利用のアプリケーションのApdex Tの4倍に設定されます。また、具体的な値をミリ秒単位で入力することもできます。

例：閾値をに設定 apdex_f

apdex_tのデフォルト値は100ミリ秒です。トランザクション閾値をapdex_fに設定した場合、「遅い」トランザクションは400ミリ秒になります。

このエージェントは、少量のCPUを使用することで、ウェブアプリケーションに添付された内部プロパティを隠します。この設定をfalseに変更した場合、エージェントのオーバーヘッドを若干減少させる場合がありますが、エージェントのパフォーマンスにも作用する可能性があります。

trueに設定されていると、エージェントはトランザクショントレースの属性をキャプチャーします。

トランザクショントレースから除外する属性の接頭辞。末尾に*をワイルドカードとして使用可能。

トランザクショントレースに含める属性の接頭辞。末尾に*をワイルドカードとして使用可能。

受信するリクエストのURLを合致させ、関連のNew Relicトランザクションを命名するためのカンマ区切りルール一覧。次の形式を使用します：

name: [
    {pattern: 'STRING_OR_REGEX', name: 'NAME'},

    {pattern: 'STRING_OR_REGEX', name: 'NAME'}

    ],

両方のパラメーターが必要。文字列に関しては、制御文字をエスケープしなくてはいけません。正規表現では、制御文字をエスケープする必要はありません。追加属性は無視されます。

正規表現は$1式のキャプチャーグループに対応しており、名前は$1式の置換文字列を使用します。正規表現は、最初にマッチする結果のみを見つけ、それ以降のマッチは無視します。詳しくはNode.jsトランザクションによるAPIの命名を参照してください。

NEW_RELIC_NAMING_RULES環境変数に関しては、ルールをカンマ区切りのJSONオブジェクトリテラルとして渡します。

NEW_RELIC_NAMING_RULES='{"pattern":"^t","name":"u"},{"pattern":"^u","name":"t"}'

エージェントに無視してほしいリクエストURLの一覧を定義。一覧をパターンとして指定します。文字列または正規表現が可能です。

これを有効にすると、エージェントは他の命名ロジックの影響を受けないトランザクション（API、ルール、またはメトリック正規化ルールなど）の名前をNormalizedUri/*に変更します。これをfalseに設定すると、エージェントはトランザクション名をUri/path/to/resourceに変更します。

これを有効にすると、エージェントがトランザクションイベントをNew Relicに送信します。このイベントのデータには、トランザクションのタイミング、トランザクション名、またあらゆるカスタムパラメーターが含まれます。これが無効になると、エージェントはこうしたデータを収集せず、New Relicに送信することもありません。

エージェントが1分あたりに収集するイベントの最大数。この数を超える場合、エージェントは統計的サンプリングを収集します。

10,000を超える設定は推奨されません。サーバーによって1分あたりのデータの上限は10,000に制限されます。

エージェントがNew Relicコレクターと通信できない場合に保管する最大イベント数を定義。以前の収集サイクルの値は新しいサンプリングにマージされ、このオプションは最大数を制限します。必ず、この数がmax_samples_per_minuteよりも大きいことを確認してください。たとえば、倍の数に設定しましょう。この値を増やす前に、メモリオーバーヘッドを考慮してください。

エージェントが1分あたりに収集するイベントの最大数。この数を超える場合、エージェントは統計的サンプリングを収集します。

trueに設定されていると、エージェントはトランザクションイベントの属性をキャプチャーします。

トランザクションイベントから除外する属性の接頭辞。末尾に*をワイルドカードとして使用可能。

トランザクションイベントに含める属性の接頭辞。末尾に*をワイルドカードとして使用可能。

BrowserインストゥルメンテーションのJavaScriptヘッダーを生成します。このデフェルト設定はtrueであるものの、ブラウザモニタリングを有効にしない限り、エージェントはブラウザJSコードのインジェクションを行いません。この値をfalseに設定することで、有効にしてブラウザタイミングヘッダーを追加した場合でも、アプリケーションのブラウザモニタリングを無効にできます。

trueの場合、サーバーからミニファイされていないソースをリクエストします。

trueの場合、エージェントはブラウザモニタリングにカスタム属性を送信します。

ブラウザモニタリングから除外する属性の接頭辞。末尾に*をワイルドカードとして使用可能。

ブラウザモニタリングに含める属性の接頭辞。末尾に*をワイルドカードとして使用可能。

これを有効にすると、エージェントはrecordCustomEvent()で記録したカスタムイベントをNew Relicに送信します。これが無効になると、エージェントはこうしたデータを収集せず、New Relicに送信することもありません。

エージェントが1分あたりに収集するカスタムイベントの最大数を定義。カスタムイベント数がこの上限を超えた場合、エージェントは統計的サンプリングを収集します。

これを有効にすると、エージェントはスロークエリの詳細を収集します。

エージェントが1分あたりに収集するスロークエリの最大数を定義。エージェントは、上限に達した後の追加のクエリを破棄します。

New Relicで表示するカスタムホスト名を指定。このフィールドを設定しない場合、os.hostname()をコールして得られるデフォルトのホスト名を引き続き使用します。

• デフォルトのホスト名設定を使用した場合、New Relicはos.hostname()を通じてホスト名を探します。
• このコールが失敗した場合、New RelicはホストのIPを名前に使用します。
• ipv_preference: 4もしくはipv_preference: 6を設定した場合、New Relic UIに表示されるIPアドレスの種類（IPv4もしくはIPv6）を選択できます。

newrelic.jsを含むディレクトリへのパス。これは、環境変数としてのみ利用できます。ご自分の設定ファイルで設定することはできません。

使用した場合、エージェントがnewrelic.jsから構成設定を読み取ることができなくなります。デフォルト値と環境変数の値は引き続き設定されます。

これは、環境変数としてのみ利用できます。ご自分の設定ファイルで設定することはできません。

これを有効にすると、エージェントは一部のデータベースドライバ向けデータストアインスタンスのメトリクス（ホストとポートなど）を収集します。これらは、スロークエリトレースとトランザクショントレースで報告されます。

これを有効にすると、エージェントは一部のデータベースドライバ向けスロークエリトレースとトランザクショントレースのデータベース名を収集します。

trueに設定すると、New Relicが監視する複数のアプリケーションをまたいだトランザクションをトレースします。

falseである場合、エージェントはキャプチャーしたエラーメッセージを編集します。

ディストリビューティッド（分散）トレーシングを有効にするには、これをtrueに設定します。

たとえば、設定ファイルでこれを有効にするには、次のものを使用します：

distributed_tracing: {
   enabled: true
}

アウトバウンドリクエストに添付されたNew Relicヘッダーを除外するには、これをtrueに設定し、ディストリビューティッド（分散）トレーシング用のトレースコンテキストヘッダーにのみ依存します。これがfalseの場合、両方のタイプのヘッダーを使用します。

たとえば、設定ファイルでこれを有効にするには、次のものを使用します：

distributed_tracing:{
   enabled: true,
   exclude_newrelic_header: true
}

スパンイベントのレポートをオンまたはオフにする。

この設定は、スパンの属性レポートをオンまたはオフにするために使用できます。ルートレベルでattributes.enabledがfalseである場合は、この設定方法にかかわらず、属性はスパンと一緒に送信されません。

属性がスパンに対して有効になっている場合は、このリストにあるすべての属性キーがスパンに添付されます。詳しくはエージェント属性ルールを参照してください。

このリストにあるすべての属性キーは、スパンと一緒に送信されません。詳しくはエージェント属性ルールを参照してください。

Infinite Tracing トレース オブザーバーのホストエントリを取得する方法については、「トレースオブザーバーのエンドポイントを検索または作成する」をご覧ください。

コンテキストのログを自動生成できるようにします。

APM概要ページのログチャートで使用するロギングメトリクスをエージェントが収集するかどうか切り替えます。

エージェントがNew Relicへの送信用にログレコードを収集するかどうかを切り替えます。

1分あたりにNew Relicに送信するログレコードの数。ログ転送を使用する場合の全体的なメモリ消費を制御します。

エージェントが標準ログ出力でローカルログ装飾を実行するかどうかを切り替えます。