Node.jsエージェントを手動でインストール

エージェントを手動でインストールまたは更新するには:

  1. アプリケーションのルートディレクトリで以下のコマンドを実行して、npmからエージェントの最新バージョンをインストールします。

    npm install @contrast/agent

    または、yarnを使用する場合、次のコマンドを実行してエージェントをインストールします。

    yarn add @contrast/agent

    注記

    Node.jsエージェントに含まれるオプションの依存関係をインストールしたくない場合は、インストールコマンドにCLIフラグの--no-optionalを追加するか、NPMRCファイルにoptional=falseを追加してください。

  2. 環境変数を使用して、エージェントの認証キーを指定します。 Node.jsアプリケーションが実行時に環境変数にアクセスできるようにしてください。

    または、こちらのテンプレートを使用してYAML設定ファイル(contrast_security.yaml)を作成し、認証キーを指定することもできます。contrast_security.yamlは、アプリケーションのルートディレクトリに作成してください。

  3. アプリケーションのpackage.jsonファイルの"scripts"セクションに次のコマンドを追加します。

    "scripts": {
        "contrast": "node -r @contrast/agent <app-main>.js",
        "start": ...,
        "test": ...
    }
    
  4. エージェントを有効にしてアプリケーションを実行します。

    npm run contrast

    ヒント

    上記のnpmスクリプトを変更して、別の設定ファイルの場所など実行時の他の設定を指定することもできます。

  5. 手動または自動テストを行ってアプリケーションを操作し、エージェントがインストールされた状態でアプリケーションが正しく機能することを確認してください。

  6. アプリケーションサーバがContrastに認識され、アプリケーションがContrastに報告されていることを確認します。