Node.jsエージェントのインストール

基本的なNode.jsエージェントのインストールを完了するには、ガイド付きインストールを使用して自動インストールを行うか（EUにお住まいの場合はEUを選択）、本ドキュメントに記載されている指示に従ってください。いずれにしても、アカウントをまだお持ちでない場合は、New Relicアカウントが必要です。（永久無料です。）

Node.js用エージェントは、Node Package Manager (npm)リポジトリとGitHubで公開されています。

Node.jsエージェントのインストール

Node.jsエージェントをインストールするには：

1. New Relicアカウントを作成します。アカウントをお持ちでない場合は、無料でサインアップできます。クレジットカードは不要です。

2. システム要件を満たしていることを確認します。特に、サポートされているNode.jsバージョンを使用していることを確認します。

3. 監視するアプリケーションごとにコマンドnpm install newrelicを使用します。アプリがこれらのApolloサーバーモジュールのいずれかを使用している場合は、npm install @newrelic/apollo-server-pluginを使用してApolloプラグインをインストールします。@newrelic/apollo-server-pluginの使用方法の詳細については、こちらを参照してください。

   重要

   Next.jsを使用している場合は、このNext.jsアプリの例をご覧ください

4. node_modules/newrelicから、newrelic.jsをアプリのルートディレクトリにコピーします。

5. newrelic.jsファイル、または環境変数を使用して、エージェントを設定します。

   • ライセンスキーを使用してlicense_key設定をカスタマイズします。
   • 1つまたは複数の意味のあるアプリケーション名を使用して、app_name設定をカスタマイズします。

6. アプリの起動スクリプトに-r newrelicを追加します。たとえば、アプリケーションのエントリポイントが./dist/server.jsの場合、次のようにrequireフラグを使用します。

   bash

   コピー

   $
   node -r newrelic ./dist/server.js

   Dockerコマンドの例：

   CMD ["node", "-r", "newrelic", "server.js"]

   コピー

   重要

   Next.js アプリの場合は、NODE_OPTIONS経由でエージェントを読み込みます。

   CMD ["NODE_OPTIONS='-r newrelic'", "next", "start"]

   コピー

   Nest.jsおよびnest startコマンドを使用してアプリケーションを起動する場合は、New Relicエージェントnest start --exec 'node -r newrelic'を読み込むように起動バイナリを変更します。以下は、Nest.jsアプリケーションの例です

   Node.jsコマンドラインオプション-rの詳細については、こちらを参照してください。

   重要

   -r必須フラグを使用できない場合は、アプリのメインモジュールの最初の行をrequire('newrelic')として使用することもできます。NoteBabelまたは類似のトランスパイラーrequire('newrelic')を使用している場合、インストゥルメンテーションの問題が発生します。

   これらのオプションがどちらも機能しない場合（例：アプリケーションのブートストラップ中にAPIキーを遠隔地から非同期的に読み込む場合）、newrelic.instrumentLoadedModuleを使用して、既に読み込み済みのサポート対象モジュールにストックインストゥルメンテーションを追加することもできます。

   // module loaded before newrelic
   const expressModule = require('express');
   
   // load the agent
   const newrelic = require('newrelic');
   
   // instrument express after the agent has been loaded
   newrelic.instrumentLoadedModule(
     'express',    // the module's name, as a string
     expressModule // the module instance
   );

   コピー

7. オプション：追加のNode.jsランタイムレベル統計情報を取得するため、@newrelic/native-metricsパッケージがインストールされていることを確認してください。

8. ある程度のトラフィックを生成し、APM UIにデータが表示されるまで数分間待ちます。

newrelic.js、または環境変数を使用して、さらにエージェントの動作をカスタマイズできます。エージェント設定をアプリケーションから切り離しておくには、NEW_RELIC_HOME環境変数を編集してください。

詳細については、APIドキュメントを参照してください。

APMおよびインフラストラクチャデータのログを表示

また、ログとアプリケーションのデータを統合して、トラブルシューティングをより簡単かつ迅速にできます。コンテキストのログでは、エラーとトレースに関連するログメッセージをアプリケーションのUIで直接表示できます。また、Kubernetesクラスタなど、インフラストラクチャデータのコンテキストでログを表示することもできます。別のUIページに切り替える必要はありません。

Node.jsエージェントを最新状態で維持する

確実にNew Relicの最新バージョンを使用できるよう、Node.jsのリリースノートを参照してください。該当する場合、リリースノートにはNode.jsエージェントの更新手順を含んだダウンロードリンクが掲載されています。

トラブルシューティング

エージェントの更新後、ある程度のトラフィックを生成してから数分待ちます。New Relic UIにデータが表示されない場合は、トラブルシューティング手順を参照してください。