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

全てのエージェントには基本の設定があり、設定値には優先順位があります。

Node.jsエージェントを設定する方法はいくつかありますが、一般的には以下のようになります。

  • 組織やコンテナ内の全てのアプリケーションに共通する設定値(例えば、ログのリダイレクトやプロキシの設定など)を指定するには、YAML設定ファイルを使用します。こちらのYAMLテンプレートに、Node.jsエージェントで有効な設定オプションが全てあります。YAML設定についての説明は、こちらを参照してください。

  • エージェントの認証キーやアプリケーション固有の設定値を指定するには、環境変数を使用します。環境変数についての説明は、こちらを参照してください。

ヒント

設定オプションによっては、コマンドラインの引数として指定することもできます。

環境変数

アプリケーション固有の設定値(サーバの環境、アプリケーション名、エージェントログの設定など)には、環境変数を使用します。また、Node.jsエージェントで有効なその他のプロパティの設定にも環境変数を使用できます。

有効なプロパティの全リストはNode.jsエージェントのYAMLテンプレートにありますが、ここではよく使用される環境変数をいくつか紹介します。

パラメータ

説明

CONTRAST__API__SERVICE_KEY

Contrastとの通信に必要なサービスキーを設定します。

CONTRAST__API__API_KEY

Contrastとの通信に必要なAPIキーを設定します。

CONTRAST__API__USER_NAME

Contrastとの通信に必要なユーザ名を設定します。

CONTRAST__API__URL

Contrast WebインターフェイスのURLを設定します。

CONTRAST__APPLICATION__NAME

Contrastに報告されるアプリケーション名を設定します。

CONTRAST_CONFIG_PATH

設定すると、YAML設定ファイルのデフォルトの場所を上書きします。(他の環境変数とは異なり、この環境変数はYAMLプロパティとして設定することはできす、アンダースコアは1つだけです。)

CONTRAST__SERVER__PATH

Contrastで報告されるサーバのパスを上書きします。

CONTRAST__AGENT__LOGGER__APPEND

falseに設定すると、毎日ログファイルを追加してローテーションする代わりに、起動時に新しいログファイルを作成します。デフォルトは、trueです。

CONTRAST__AGENT__LOGGER__LEVEL

ログのレベル:FATAL、ERROR、WARN、INFO、DEBUG、TRACEのいずれかを設定します。デフォルトは、ERRORです。

CONTRAST__AGENT__LOGGER__PATH

Contrastのデバッグログを保存するパスを指定します。デフォルトは、node-contrast.logです。

CONTRAST__AGENT__LOGGER__STDOUT

falseに設定すると、標準出力(stdout)へ出力されなくなります。デフォルトは、trueです。

注記

Node.jsエージェントでは、環境変数DEBUGに手動の設定が必要です。環境変数DEBUGにContrastの名前空間を含むように設定(DEBUG=contrast:*)しない限り、INFOレベルのメッセージはコンソールには記録されません。名前空間を操作して、特定のパスの表示/非表示を切り替えることもできます。これは、ファイルシステムにアクセスできない環境(DockerやECSなど)で有用です。

Node.jsのログをリダイレクトしたい場合は、npmのサイトの他の例を参考にするか、サポートまでお問い合わせください。

Node.jsエージェントのYAMLテンプレート

以下のテンプレートを使用して、YAML設定ファイルでNode.jsエージェントの設定を指定します。

https://docs.contrastsecurity.com/common-agent-config/node_contrast_security.yaml