Node.jsエージェントの設定
全てのエージェントには基本の設定があり、設定値には優先順位があります。
Node.jsエージェントを設定する方法はいくつかありますが、一般的には以下のようになります。
ヒント
Contrastエージェント設定エディタを使用すると、 YAML設定ファイルの作成やアップロード、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__SERVER__NAME | コンテナ化されたアプリケーションで多数のサーバレコードが生成される場合に、一貫したサーバ名を指定します。マイクロサービス名やアプリ名になることが考えられます。 |
CONTRAST__AGENT__DIAGNOSTICS__ENABLE | 診断やトラブルシューティングの情報を追跡するために、起動時に設定ファイルとシステムファイルを作成します。デフォルトは、 |
CONTRAST__AGENT__LOGGER__APPEND |
|
CONTRAST__AGENT__LOGGER__LEVEL | ログのレベル： |
CONTRAST__AGENT__LOGGER__PATH | Contrastのデバッグログを保存するパスを指定します。デフォルトは、node-contrast.logです。 |
CONTRAST__AGENT__LOGGER__STDOUT |
|
Node.jsのログをリダイレクトしたい場合は、サポートにお問い合わせください。
注記
v4(旧エージェント)の場合:
Node.jsエージェントでは、環境変数DEBUGに手動の設定が必要です。環境変数DEBUGにContrastの名前空間を含むように設定(DEBUG=contrast:*)しない限り、INFOレベルのメッセージはコンソールには記録されません。名前空間を操作して、特定のパスの表示/非表示を切り替えることもできます。これは、ファイルシステムにアクセスできない環境(DockerやECSなど)で有用です。
Node.jsのログをリダイレクトしたい場合は、npmのサイトの他の例を参考にするか、サポートまでお問い合わせください。