ヘルプ APM Javaアプリケーションパフォーマンス監視 Site24x7 APMインサイト Javaエージェント – Ansible Role

Site24x7 APMインサイト Javaエージェント – Ansible Role

概要

Ansible Roleを使用して、アプリケーションサーバーにSite24x7 APMインサイトJavaエージェントをデプロイおよび構成できます。
Apache Tomcat、Eclipse Jetty、WildFlyなどのアプリケーションサーバーとフレームワークをサポートしています。

要件

ターゲットホストでunzipコマンドを使用できる必要があります。
RedHat、Rocky、AlmaLinux、Debian、Darwin等のオペレーティングシステムをサポートします。
Ansibleはコントロールノードにインストールする必要があります。Ansibleインストールガイド

設定

Site24x7 APMインサイト Ansible Roleで以下のプロパティを設定することで、アプリケーションのパフォーマンス監視が可能になります。

APMインサイトの設定プロパティ

これらの設定は、apminsight_props変数を通じて指定し、アプリケーション監視に不可欠な構成を定義できます。

プロパティ	説明	必須
app_name	監視対象のアプリケーション名。指定しない場合は、インベントリファイルのサーバーグループに基づいて自動生成された名前が割り当てられます。	No
license_key	認証とデータ収集に使用されるSite24x7 APMインサイトのライセンスキー。Site24x7アカウントからこのキーを取得します。	Yes

ロールのインストールプロパティ

これらのプロパティは、Site24x7 APMインサイトエージェントをWebサーバーと統合するために必要なサーバー固有の構成を定義します。

プロパティ	説明	必須	デフォルト
server_type	Webサーバーの種類を指定します（例：tomcat、jetty、wildfly）。エージェントとの互換性が保証されます。	Yes	-
server_version	Webサーバーのバージョンを定義し、適切な設定を行います。	No	-
jvm_config_file	Webサーバーが使用するJVM設定ファイルへのパス。ファイルが存在しない場合は作成されます。例:Tomcat用setenv.sh	Yes	-
service_name	管理を容易にするために、監視対象のサービスまたはアプリケーションを識別します。	No	-
restart_web_server	インストール後にWebサーバーを再起動するかどうかを指定します。	No	true
agent_download_dir	エージェントファイルが保存されるディレクトリ。	No	/opt/apm
enable_agent	APMインサイトエージェントを有効にするかどうかを制御します。falseに設定すると、データ収集は行われません。	No	true

Ansibleを使用してSite24x7 APMインサイト Javaエージェントをインストールする方法

Ansible Roleを使用してアプリケーションサーバー上でSite24x7 APMインサイト Javaエージェントを設定するには、以下の手順に従います。

ステップ1：ロールを抽出して設定

次のコマンドを使用してAnsible Roleを抽出し、名前をSite24x7-APMに変更します。

curl -L -o Site24x7-APM-Ansible-main.zip https://github.com/site24x7/Site24x7-APM-Ansible/archive/refs/heads/main.zip && unzip Site24x7-APM-Ansible-main.zip && mv Site24x7-APM-Ansible-main Site24x7-APM

my-playbook.ymlという名前のplaybookとmy-inventory.ymlという名前のイベントファイルを作成し、両方のファイルをSite24x7-APMフォルダの横に配置します。

上記のコマンドでzipファイルを解凍すると、my-playbook.ymlとmy-inventory.ymlを含む最終的なフォルダ構造は以下のようになります（サンプル）。
├─ Site24x7-APM
├ ├── defaults
├ ├── handlers
├ ├── meta
├ ├── tasks
├ ├── tests
├ ├── vars
├ ├── README.md
├─ my-playbook.yml
├─ my-inventory.yml

ステップ2：インベントリとplaybookの設定

以下のようにインベントリファイルを作成

my-inventory.ymlファイルの例

prod_webserver:
  vars:
    ansible_user: fedora
    server_type: tomcat
  hosts:
    java_server_one:
      ansible_host: 10.0.20.5
      java_agent_host_config:
        app_name: Example App
    java_server_two:
      ansible_host: 127.0.40.2

以下のようにplaybookファイルを作成

my-playbook.ymlファイルの例

- hosts: prod_webserver
  vars:
    apminsight_props:
      app_name: <Your Application Name>
      license_key: <Your License Key>
    install_props:
      server_type: 'tomcat'
      jvm_config_file: '/usr/share/tomcat8/bin/setenv.sh'
      service_name: 'tomcat'
      server_version: '8'
      restart_web_server: true
  tasks:
   - include_role:
       name: Site24x7-APM

license_keyプロパティは必須です。Site24x7 APMインサイトページから取得する必要があります。

ステップ3：エージェントのインストール

以下のコマンドを実行して、Ansible playbookを実行します。
```
ansible-playbook -i ./my-inventory.yml ./my-playbook.yml
```

エージェントがインストールされ、アプリケーションサーバーが期待通りに動作していることを確認してください。

アンインストール方法

Ansibleを使用してSite24x7 APMインサイトJavaエージェントをアンインストールするには、Ansible playbookで以下の変数プロパティを使用します。

プロパティ	説明	必須	デフォルト
uninstall	エージェントをアンインストールするにはtrueを設定します。	Yes	-

Ansible playbookの例

Site24x7 APMインサイトJavaエージェントをアンインストールするAnsible playbookの例は以下です。

- hosts: webservers
  vars:
    uninstall: true
  tasks:
   - include_role:
       name: Site24x7-APM

アンインストールプロセスが開始されます。

アンインストール手順は、Site24x7 APMインサイトJavaエージェントがAnsibleを使用してインストールされている場合にのみ機能します。
エージェントをアンインストールするには、必ずuninstall変数をtrueに設定してください。falseに設定するか省略すると、エージェントはアンインストールできません。
Ansibleインベントリファイルのwebserversをホストグループの名前に置き換えてください。
エージェントをアンインストールするには、Site24x7-APMロールをplaybookに必ず含める必要があります。

ヘルプ APM Javaアプリケーションパフォーマンス監視 Site24x7 APMインサイト Javaエージェント – Ansible Role