本文へスキップ

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

Node.jsモニタリングサービスを使用するには、モニタリング対象アプリケーションにモニタリングエージェントをインストールする必要があります。インストールはnpm(Node Package Manager)を使用してください。

  • サービス中のNode.jsアプリケーションのディレクトリパスに、WhaTapエージェントモジュールをインストールしてください。

  • WhaTapエージェントの環境設定(whatap.conf)を作成してください。

  • Node.jsサービスを再起動します。

エージェントダウンロード​

  1. サービス中のNode.jsアプリケーションのディレクトリパスに、エージェントモジュールをインストールしてください。

    $ npm install --save whatap

  2. node_modules/whatapパスのwhatap.confファイルをコピーして、プロジェクトのルート(root)パス(package.jsonファイルと同じ位置)に貼り付けます。

  3. WhaTapモニタリングサービス 画面に移動してください。

  4. 作成したプロジェクトを選択しインストール手順セクションのエージェントのダウンロード セクションから、次をコピーしてください。

    Example
    license={アクセスキー}
    whatap.server.host={収集サーバーIP}

  5. whatap.confファイルに貼り付けます。

ホスト(whatap.server.host) のアドレスは、WhaTap proxyをインストールしたサーバーのアドレスです。スラッシュ(「/」)を区切り文字として使用し、WhaTap proxy が実行中のサーバーにアドレスを入力することができます。

エージェントの構成ファイルについては、以下を参照してください。

Tips

Next.jsまたはNuxt.jsなどのサーバーサイドレンダリング(Server-side Rendering、SSR)フレームワークでアプリケーションをモニタリングするためにCustom Serverの設定が必要です。一般的なNode.jsフレームワーク(例、Express.js、Nest.js)とは異なるアプローチが求められます。詳細については、以下の文書を参照してください。

活用方法​

WHATAP_HOME 環境変数を設定する​

アプリケーションディレクトリのパスを WHATAP_HOME 環境変数に設定してください。指定しない場合は既定で現在の実行ディレクトリ(process.cwd())が使用されます。

export WHATAP_HOME={app_root_path}

WHATAP_HOME のパスに whatap.conf ファイルを作成し、次の値を設定してください。

# whatap.conf
app_name=MyNodeApp              # アプリケーション名、デフォルト: NODE
app_process_name=node           # プロセス名（例: node）

エージェントを設定する​

アプリケーションの進入点(メインモジュール)ファイルの最上段に次のコードを追加します。例えばExpress.jsアプリケーションではapp.jsまたはserver.jsファイルが進入点(メインモジュール)です。Nest.jsといったフレームワークを使用する場合は、main.tsファイルなどです。

CommonJS
var whatap = require('whatap').NodeAgent;

環境ごとのエージェントオプションを設定する​

アプリケーションの各環境に合わせた設定を適用すべき時は、whatap.confファイルの代わりに、アプリケーションのエントリポイントファイルから設定を変更できます。以下のコードを参考にして環境に合わせた設定を適用します。

process.env.WHATAP_CONF = 'whatap_dev.conf'; // Setting for development environment
var WhatapAgent = require('whatap').NodeAgent;

  • 環境ごとに異なるプロジェクトを実行する場合：

    同じアプリケーションでも開発(dev)、テスト(test)、運営(prod) など各環境に合わせた設定が必要です。上の例のようにWHATAP_CONF環境変数を使用し、開発環境に適した設定を適用できます。これにより、環境ごとに異なる設定を簡単に管理できます。

  • エージェントオプションを環境に応じて異なる設定にする必要がある場合：

    開発環境ではロギングレベルを高め、運用環境ではパフォーマンスを最適化するために異なるオプションを設定できます。この場合、アプリケーションのエントリポイントファイルで、各環境に合わせてエージェントオプションを修正します。

  • PM2のクラスター モードでアプリケーションを実行する場合：

    クラスターモードで複数のアプリケーションインスタンスを実行すると、単一の app_name(WHATAP_HOME) に統合して表示されます。

エージェントのグループ単位の機能を使用する​

エージェントのグループ単位の機能には、グループトポロジ、統合トポロジなどがあります。次のコードは、{グループ識別子}の部分をエージェントグループ名に置き換えて使用してください。

process.env.WHATAP_OKIND = '{グループ識別子}';
var WhatapAgent = require('whatap').NodeAgent;

// または whatap.conf に次のように記述
whatap.okind = {グループ識別子}

環境変数として設定可能なオプション​

whatap.confファイルが使用できないため、ソースファイルに環境変数としてWhaTapエージェントオプションを設定する必要があります。

app.js
process.env.profile_http_header_enabled=false;
process.env.profile_http_parameter_enabled=false;

process.env.profile_basetime=500;

process.env.auto_oname_enabled=false;
process.env.auto_oname_prefix='nodejs';

process.env.mtrace_rate=0;
process.env.mtrace_spec='v1';
process.env.stat_mtrace_enabled=false;
process.env.stat_domain_enabled=false;
ノート

Node.jsで設定できるオプションの詳細については、次の文書を参照してください。

次のステップ​

  • インストールの点検

    プロジェクトの生成とエージェントのインストールまですべて適用した場合は、次の文書で点検事項を確認します。

  • エージェント設定

    エージェント設定(whatap.conf)ファイルにオプションを適用して、モニタリングのための様々な機能を提供します。 デフォルト設定から、サーバーの接続とデータ転送の設定、複数のアプリケーションサーバーの設定ファイルの管理方法、トランザクションの追跡などが含まれます。 詳細については、次の文書を参照してください。

  • モニタリングの開始

    すべての設定を完了してから、アプリケーションサーバーを再起動します。 エージェントが情報の収集を開始します。 まず、アプリケーションメニューでモニタリングデータが収集されていることを確認します。 アプリケーションについての詳細は、次の文書を参照してください。

最終修正：