Web Server Agent インストール

Web Server Agent(exem-webserver-agent)は、Nginx・ApacheのWebサーバーのパフォーマンス指標を収集してエクセムワン収集サーバー(Receiver)に送信するモニタリングエージェントです。

Webサーバーモニタリングは2つの構成要素で成り立ちます。

• Web Server Agent — 収集サーバー(Receiver)と通信する中間エージェントです。BinaryまたはDocker方式でインストールします。
• Web Module — Webサーバーに直接搭載され、データを収集してWeb Server Agentに送信するモジュールです(Nginx ModuleまたはApache Module)。

[Nginx/Apache] ←→ [Web Module] → (TCP 12848) → [Web Server Agent] → (gRPC 9009) → [Receiver]

サポート環境​

nginxモジュールのサポート環境​

httpdモジュールのサポート環境​

通信ポート​

インストール前にファイアウォールで以下の2つのポートを開放しておく必要があります。

エージェントを登録する​

Web Server Agentをインストールする前に、エクセムワンのWeb UIでエージェントを先に登録しておく必要があります。登録時に発行されるエージェントIDとアクセストークンはインストール段階で必要になるため、必ず記録しておいてください。

1. 左側メニューで[プロフィール > 環境設定]に移動します。
2. [管理 > エージェント]メニューを選択します。
3. 上部の[エージェント追加]ボタンをクリックします。
4. エージェントタイプを「Webサーバー」として選択し、エージェント名を入力します。
5. [更新]ボタンをクリックして、エージェントIDとアクセストークンを発行します。
6. [保存]ボタンをクリックします。

エージェント一覧に新しい項目が表示されれば登録完了です。

インストール方法​

Web Server AgentはDockerとBinaryの2つの方式でインストールできます。環境に合った方式を選択してください。

Dockerでインストールする​

1. exem-webserver-agent-package.tar.gzファイルを解凍します。

2. Dockerイメージをロードします。

   docker load -i exemone-webserver-agent-v3.0.12.tar.gz
   

3. exem-webserver-agent-package/.envファイルを開いて実行環境を設定します。

   # 実行ユーザーID
   EXEMONE_USER_UID=1000
   EXEMONE_USER_GID=1000
   
   # パッケージ実行パス
   EXEMONE_WEBSERVER_AGENT_PATH=exem-webserver-agent-package
   
   # Dockerイメージおよびバージョン
   WEBSERVER_AGENT_IMAGE=maxgauge/exemone-webserver-agent
   WEBSERVER_AGENT_VERSION=v3.0.16
   

4. exem-webserver-agent-package/configs/.envファイルを開いてエージェント情報を入力します。エージェント登録時に発行された値を使用します。

   WEB_AGENT_NAME=<エージェント名>
   WEB_AGENT_ID=<エージェントID>
   WEB_AGENT_ACCESS_TOKEN=<アクセストークン>
   WEB_AGENT_RECEIVER_ADDR=<Receiver IP>:9009
   

5. exem-webserver-agent-package/docker-compose.ymlのports項目に12848ポートを追加します。

6. インストールスクリプトに実行権限を付与します。

   chmod +x exem-webserver-agent-package/install.sh
   

7. Web Server Agentを起動します。

   cd exem-webserver-agent-package
   ./scripts/restart.sh
   

コンテナが正常に起動すればインストール完了です。

Binaryでインストールする​

1. exem-webserver-agent_${VERSION}.binインストールファイルを準備します。

2. 実行権限を付与します。

   chmod +x exem-webserver-agent_${VERSION}.bin
   

3. インストールファイルを実行します。

   ./exem-webserver-agent_${VERSION}.bin
   

4. インストールメニューで[1]を入力してインストールを開始します。JAVA 17以上がインストールされているかの確認プロンプトで[y]を入力します。

5. エージェント情報入力プロンプトで、エージェント登録時に発行されたToken、Agent ID、Agent Name、Receiver IPを入力します。

6. インストールディレクトリを入力します。入力したパスの下にwebserverフォルダが自動的に作成されます。

7. インストールが完了したら、<インストールパス>/webserver/bin/ディレクトリでエージェントを起動します。

   ./startAgent.sh
   

startAgent.shに入力した情報が自動的に反映されていれば、インストール完了です。

設定方法​

Web Server Agentのインストール後、モニタリング対象のWebサーバーにWeb Moduleをインストールして設定します。

Nginxモジュールを設定する​

1. Nginxのバージョンを確認します。

   nginx -V
   

2. setup_exem-nginx-module_{Version}.binインストールファイルを実行します。

   ./setup_exem-nginx-module_{Version}.bin
   

   インストール中に以下の項目を入力します。

   プロンプト	入力値
   Install Nginx Version	モニタリング対象のNginxバージョン
   Install Directory	インストールパス(デフォルト値: /home/exemone/nginx-module)
   nginx module config filename	設定ファイル名(デフォルト値: exem_ngx_mod.conf)
   Do you want to fix the 'unique id'?	yesを推奨。固定しない場合、Nginx再起動時に新しい項目として登録されます
   Group ID to register	使用するグループID
   Module Name to register	画面に表示するWebサーバー名(デフォルト値: hostname)

3. インストール完了後に出力されるnginx.conf追加案内を確認し、モニタリング対象Nginxのnginx.confに以下の内容を追加します。

   load_module "<インストールパス>/modules/ngx_http_exem_module_<バージョン>.so";
   http {
     include <インストールパス>/conf/exem_ngx_mod.conf;
   }
   

4. <インストールパス>/conf/exem_ngx_mod.confファイルでWeb Server Agent IPを設定します。Web Server Agentが別のサーバーにある場合のみ変更が必要です。

   exem_connect_ip <Web Server Agent IP>;
   # exem_connect_port 12848;  # デフォルト値を使用する場合はコメントのまま
   

5. Nginxを再起動します。

   nginx -s reload
   

setenforce 0

Nginx Module 設定オプション​

Apacheモジュールを設定する​

1. Apacheのバージョンを確認します。

   apache2 -v   # Debian/Ubuntu
   httpd -v     # Red Hat系
   

2. setup_exem-httpd-module_{Version}.binインストールファイルを実行します。

   ./setup_exem-httpd-module_{Version}.bin
   

   インストール中に以下の項目を入力します。

   プロンプト	入力値
   Install HTTPD Version	2.4
   Install Directory	インストールパス
   ExEm Connect IP	Web Server Agent IP(デフォルト値: 127.0.0.1)
   ExEm Connect Port	Web Server Agentポート(デフォルト値: 12848)
   Group ID to register	使用するグループID
   Module Name to register	画面に表示するWebサーバー名(デフォルト値: hostname)
   Do you want to fix the 'unique id'?	yesを推奨

3. インストール完了後に出力されるhttpd.conf追加案内を確認し、モニタリング対象Apacheの設定ファイルに以下の内容を追加します。

   # exem module
   Include <インストールパス>/conf/exem_httpd_mod.conf
   

   Apache設定ファイルの場所は環境によって異なります。

   環境	設定ファイルパス
   Debian/Ubuntu	/etc/apache2/apache2.conf
   Red Hat系	/etc/httpd/conf/httpd.conf

4. Apacheを再起動します。

   apachectl graceful
   

Apache Module 設定オプション​

CPU/メモリ指標を連携する​

Webサーバー画面でProcess CPU、Process Memoryなどのプロセス使用量を併せて確認するには、Web Moduleとホストエージェントの BID を同じ値に設定する必要があります。

1. Web Module設定ファイルでBIDを設定します。

   • Nginx: exem_ngx_mod.confのexem_bidオプション
   • Apache: exem_httpd_mod.confのExEmBIDオプション

2. host-agent設定ファイルで同一のBID値を設定します。

設定が完了すると、Webサーバー画面のMetricタブでProcessタグが付いたCPU・Memory指標を確認できます。