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

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

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

  1. Instana の AutoTrace ウェブフックをインストールしてください。

     注：Instana （ Node.js SDK）の使用を計画している場合は、 「 API 」と「 AutoTrace 」ウェブフックの併用に関するセクションを確認してください。

  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
 

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

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

1. 対象システムに @instana/collector パッケージをインストールします:

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

     npm install -g @instana/collector
      

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

     yarn global add @instana/collector
      

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

2. パッケージがインストールされている場所を特定する。 場所はオペレーティングシステムによって異なります。 npm がインストール済みパッケージを配置する場所の詳細については、 Node.js のフォルダに関するドキュメントを参照してください。

3. 対象システム上で、パッケージ @instana/collector とそのすべての依存関係が既知の場所（例： /path/to/instana/node_modules/@instana/collector）に確実に利用可能であることを確認してください。

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

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

• アクティベーションにはロード --require フラグを使用してください。
• アプリケーションの最初の文として、 Node.js コレクターを要求し初期化してください。

これらのメソッドは、アプリケーションコードの前に Node.js コレクタをロードおよび初期化します。

アプリケーションがECMAScriptを使用しており、 @instana/collector 依存関係としてインストールされているコレクターの場合は、 Node.js ロード フラグを使用して Instana Node.js コレクターをロードすることで、コレクターをアクティブ化できます。

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

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

  Docker でアプリケーションをビルドする場合、以下の行を (最後の FROM ステートメントの後、ビルドプロセ node スを Dockerfile 開始する ENTRYPOINT 最終的な CMD または の前に) に追加して NODE_OPTIONS 設定してください:

  • 以下のコマンドを使用して、 Instana コレクター（ Node.js18.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.js18.19 以降）をインポートします：

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

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

Node.js サーバーアプリケーションをWebpackやRollupなどのバンドラーで前処理する際は、`dependencies`フォルダ node_modules 内の依存関係コードを含めず、自身のコードのみをバンドルするようにしてください。

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

• モジュール @instana/collector では Webpack を使った前処理がサポートされません。 他の問題の中でも、コード内で使用されている動的 require ステートメントが正しく解決されていません。
• サードパーティ製ライブラリを計測対象とする場合、 npm パッケージは @instana/collectorNode.jsrequire プロセスの実行をインターセプトします。ただし、これらのライブラリが実行時に読み込まれず、代わりにビルド時に自身のコードとバンドルされる場合、この 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"externalDependencies": ["@instana/collector"] `.js/bundle.js`ファイルに``（および @instana/collector 計測対象となるその他のライブラリ）を追加する必要があります。

TypeScript やBabelなどのトランスパイラを使用している場合、トランスパイラが CommonJS またはECMAScriptのディストリビューションコードを生成することを確認してください。

ECMAScript の CommonJS ロードフラグを介してトレーサーを初期化する。

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

依存関係を または yarn --ignore-optional npm install --no-optional コマンドでインストールする場合、 npm または yarn はネイティブアドオンのインストールを試みません。

npm またはyarnによるネイティブアドオンのインストールが失敗する問題を修正するには、インストール手順からフラグを削除するか、以下のインストール手順を追加してください：

• npm install @instana/autoprofileまたはyarn add @instana/autoprofile
• npm install event-loop-statsまたはyarn add event-loop-stats
• npm install gcstats.jsまたはyarn add gcstats.js