エージェントベースの Node.js モニタリングの設定

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

• コレクタの自動インストール ( 推奨 )：コレクタを自動的にインストールするには、以下の手順を実行します：

  1. Instana AutoTrace ウェブフックをインストールします。

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

  2. Node.js アプリケーションと Instana エージェントが Kubernetes クラスターで実行される場合は、監視対象アプリケーションのネットワーク アクセスを設定します。 詳しくは、 Kubernetes ネットワークアクセスをご覧ください。

• 手動によるコレクタのインストールコレクタを手動でインストールするには、 Node.js コ レクタの手動インストールを参照してください。 自動インストールが不可能な場合のみ、手動アプローチを使用してください。

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

Instana Node.js コレクタを Cloud Foundry にインストールするには、以下のオプ ションのいずれかを選択します：

• コレクターの自動インストール(推奨)：タイル 1.177.0 およびそれ以降のバージョンでは、 Instana buildpack を使用して 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. パッケージがインストールされている場所を決定する。 場所はOSによって異なる。 npmがインストールされたパッケージをどこに置くかについての詳細は、 Node.js のフォルダーについてのドキュメントを参照してください。

3. /path/to/instana/node_modules/@instana/collector のような、よく知られた場所にあるパッケージ @instana/collector が、ターゲット・システムで利用可能であることを確認してください。

コレクタをインストールしたら、コレクタをアクティブにしてモニタを セットアップします。 手順については、 Node.js コレクターのアクティ ブ化を参照してください。

CommonJS モジュールを使用するアプリケーションの場合は、以下のい ずれかの方法を使用して Node.js コレクタをアクティブにします：

• 起動には --require ロードフラグを使用する。
• アプリケーションの最初のステートメントとして、 Node.js コレクターを要求し、初期化する。

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

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

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

• を設定する。 NODE_OPTIONS Node.js 変数を設定する ：

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

  • 以下のコマンドを使用して、Instanaコレクター（ 18.19Node.js バージョン 以降）をインポートします：

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

• 代わりに、起動 --import 時にパラメータを含めます Node.js。アプリケーションを で起動する場合は node app/index.js、コマンド --import を付加します。

  • 以下のコマンドを使用して、Instanaコレクター（ 18.19Node.js バージョン 以降）をインポートします：

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

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

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

以下の理由により、依存関係を除外しなければならない：

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

そのため、 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を使用している場合、 "externalDependencies": ["@instana/collector"] （そしておそらく @instana/collector instrumentsの他のライブラリも）を バンドルから除外するために、 angular.json ファイルに追加する必要があります。

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

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

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

npm install --no-optional または yarn --ignore-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