エージェントベースの Node.js 監視の設定

Node.js アプリケーションが Kubernetes および Red Hat OpenShift 環境で実行されている場合、以下の手順に従って、 Instana の Node.js コレクターを自動または手動でインストールできます

• コレクターの自動インストール（推奨）：コレクターを自動的にインストールするには、以下の手順を実行してください：

  1. 「 Instana 」の「 AutoTrace 」Webhookをインストールします。

     注：Instana Node.js SDK を使用する場合は、 「 API と AutoTrace Webhook の併用 」のセクションを確認してください。

  2. Node.js アプリケーションと Instana エージェントが Kubernetes クラスタ内で実行されている場合は、監視対象アプリケーションのネットワークアクセスを設定してください。 詳細については、 Kubernetes network-access を参照してください。

• コレクターの手動インストール：コレクターを手動でインストールするには、 「 Node.js コレクターの手動インストール」 を参照してください。 自動インストールが不可能な場合にのみ、手動でのインストールを行ってください。

読み取り専用システムでは、あらかじめ定義された Node.js のバージョンに対してコンパイルされたネイティブアドオンは、他のバージョンの Node.js との互換性の問題を引き起こす可能性があります。 コレクタはプリコンパイル済みのバイナリファイルを展開できないため、特定のネイティブモジュールが読み込まれなくなります。 その結果、ガベージコレクションのデータや特定のイベントループの統計情報など、一部のメトリクスは収集されません。 ただし、一般的なトレース機能には影響はありません。 詳細については、 「トラブルシューティング 」のセクションをご覧ください。

Cloud Foundry に Instana Node.js コレクターをインストールするには、次のいずれかの方法を選択してください：

• コレクターの自動インストール（推奨）：Tile 1.177.0 以降のバージョンでは、 Instana ビルドパックを使用して Node.js コレクターをインストールし、 Cloud Foundry 上の Node.js アプリケーションのセットアップを自動化してください。

• コレクターの手動インストール：コレクターを手動でインストールするには、 「 Node.js コレクターの手動インストール」 を参照してください。 自動インストールが不可能な場合にのみ、手動でのインストールを行ってください。

Instana （ Node.js ）コレクターパッケージをApigee Microgateway （別名 edgemicro ：）で使用するには、「 Instana （ Node.js ）コレクターを使用したApigee Microgatewayの監視」の手順に従ってください。

「 Instana 」の「 Node.js 」コレクターを使用して「 Next.js 」アプリケーションを監視するには、以下の手順を実行してください：

1. コレクターをグローバルまたはローカルにインストールします。
2. ロードフラグを使用してコレクターを有効にします。

Instana Node.js コレクターをインストールするには、次のコマンドを実行して、アプリケーションに npm@instana/collector パッケージをインストールしてください：

npm install --save @instana/collector@latest

コレクターをインストールしたら、コレクターを有効にして監視を設定してください。 手順については、 「 Node.js コレクターの有効化」 を参照してください。

別の方法として、以下の手順に従って Node.js コレクターをグローバルにインストールすることもできます：

1. ターゲット・システムにパッケージ @instana/collector をインストールします。

   • npm を使用している場合は、次のコマンドを実行してください：

     npm install -g @instana/collector@latest
     

   • yarn を使用する場合は、以下のコマンドを実行します。

     yarn global add @instana/collector@latest
     

   コレクターをコンテナー化アプリケーションにインストールする場合は、上記のステートメントを Dockerfileに追加できます。

2. パッケージがインストールされている場所を確認してください。 場所は、オペレーティング・システムによって異なります。 npm がインストール済みパッケージをどこに配置するかについての詳細は、 Node.js のドキュメントにある「 フォルダ」 の項目をご覧ください。

3. すべての依存関係を持つパッケージ @instana/collector が、ターゲット・システム上の既知の場所 ( /path/to/instana/node_modules/@instana/collectorなど) で使用可能であることを確認します。

コレクターをインストールしたら、コレクターを有効にして監視を設定してください。 手順については、 「 Node.js コレクターの有効化」 を参照してください。

Instana Node.js コレクターの事前構築済み圧縮パッケージを手動でダウンロードするには、 Instana Node.js collector download をクリックしてください。

監視を設定するには、 「 Node.js コレクターの有効化 」の手順に従って、コレクターを有効にしてください。

CommonJS モジュールを使用するアプリケーションでは、次のいずれかの方法で Node.js コレクターを有効にしてください：

• 有効化には、load --require フラグを使用してください。
• アプリケーションの最初のステートメントとして、 Node.js コレクターをインポートし、初期化してください。

これらのメソッドは、アプリケーションのコードが実行される前に、 Node.js コレクタを読み込んで初期化します。

アプリケーションがECMAScriptと、依存関係としてインストールされたコレクター @instana/collector を使用している場合、 Node.js ロードフラグを使用して Instana Node.js のコレクターを読み込むことで、そのコレクターを有効にできます。

アプリケーションが ECMAScript モジュールを使用する場合は、ノード実行可能ファイルを起動するときに、次のいずれかの手順を実行します。 この --import 引数を NODE_OPTIONS 設定または使用すると、アプリケーションコードの実行前に Node.js コレクタが初期化されます。 ECMAScriptモジュールに関する詳細については、 Node.js の公式ドキュメントを参照してください。

• Node.js のアクティベーションプロセスを開始する前に、変 NODE_OPTIONS 数を設定してください：

  Docker を使用してアプリケーションをビルドする場合は、次の行を に追加して NODE_OPTIONS 設定してください Dockerfile （最後の FROM ステートメントの後、および プロセ node スを開始する ENTRYPOINT 最後の CMD または の前に）：

  • Instana コレクター（ Node.js、 18.19 以降）をインポートするには、次のコマンドを使用します：

    ENV NODE_OPTIONS="--import /path/to/instana/node_modules/@instana/collector/esm-register.mjs"
     

• あるいは、 Node.js を起動する際に パラメータ --import を指定してください。アプリケーションを で起動する場合は node app/index.js、 コマンド --import を追加してください。

  • Instana コレクター（ Node.js、 18.19 以降）をインポートするには、次のコマンドを使用します：

    node --import /path/to/instana/node_modules/@instana/collector/esm-register.mjs app/index.js
     

  ローダーは、 Instana Node.js コレクターを自動的に初期化します。

WebpackやRollupなどのバンドルツールを使ってNode.jsサーバーアプリケーションを前処理するときは、「node_modulesフォルダから依存関係のコードではなく、自分のコードだけをバンドルするようにしてください。

以下の理由により、依存関係を除外する必要があります。

• モジュール @instana/collector では Webpack を使った前処理がサポートされません。 他の問題の中でも、コードで使用されている動的 require ステートメントは正しく解決されません。
• サードパーティ製ライブラリに計測機能を組み込むため、 npm パッケージは Node.js@instana/collectorrequire の処理をインターセプトします。しかし、それらのライブラリが実行時に読み込まれず、代わりにビルド時に自身のコードにバンドルされている場合、処理 require は実行されず、計測機能は適用されません。 したがって、 Instana のトレース機能は動作しないか、部分的にしか動作しません。つまり、 Node.js のコアモジュール（例：）に対してはトレースが機能しますが、それ http 以外のモジュールはデフォルトでバンドリングの対象外となっているためです。

したがって、 node_modules 内のすべてのものがすべてのコード変換から除外されるように、モジュール webpack-node-externals を使用してバンドル・プログラムを構成する必要があります。

// your webpack.config.js:

const nodeExternals = require('webpack-node-externals');

module.exports = {
  ...
  // externals: nodeModules,
  externals: [nodeExternals()],
  ...
};
 

Angular のCLIを使用する場合、特に Angular UniversalやSSR と併用する際は、 バンドル対象から除外するために、` angular.json .config.yaml`ファイルに` "externalDependencies": ["@instana/collector"] `（および必要に応じて、これを @instana/collector 計測対象とするその他のライブラリ）を追加する必要があります。

TypeScriptBabelなどのトランスパイラを使用している場合は、トランスパイラがCommonJSまたはECMAScript distのコードを生成することを確認してください。

CommonJSとECMAScript のロード・フラグによってトレーサーを初期化する。

コード内でSDKにアクセスする方法の詳細については、ECMAScriptモジュールを参照してください。