Ansible

このドキュメントには、Ansible® のドキュメントへの参照が含まれています。AppDynamics はいかなる権利も所有しておらず、そのようなサードパーティのドキュメントの正確性または完全性について責任を負いません。

AppDynamics Ansible コレクションは、AppDynamics エージェントをインストールして設定します。サポートされているすべてのエージェントを、Ansible Galaxy から Ansible® 制御ノードに自動的にダウンロードできます。オンプレミスバージョンを使用している場合は、ローカルリポジトリからエージェントをダウンロードします。これにより、エージェントの取得とアップグレードが容易になります。

使用可能な展開オプションの説明については、「共通ロールの変数」を参照してください。

AppDynamics Ansible コレクションは、エージェントが基本設定でアップグレードされるコード展開として（イミュータブル）インフラストラクチャをサポートするように構築されています。そのため、このコレクションでは、ターゲットサーバーでの手動の設定変更は考慮されません。

カスタムエージェント設定は、その設定が Ansible ロールに書き込まれている場合にのみサポートされます。AppDynamics Ansible コレクションは、ローカルまたは既存の設定を、プレイブックで定義されている変数で上書きします。そのため、カスタムエージェント設定を Ansible ロールに変換して、資産全体の展開と設定の一貫性を確保することを強く推奨します。

次の図では、ワークフローについて説明しています。

AppDynamics ダウンロードポータルまたはカスタムエンドポイントから AppDynamics エージェントをダウンロードします。

galaxy.ansible.com から AppDynamics Ansible コレクションをダウンロードします。 

（オプション）ファイルサーバーを管理している場合は、カスタムエンドポイントからエージェントバイナリをダウンロードします。

プレイブックを使用してエージェントを設定します。「プレイブック」を参照してください。

ファイルサーバーとプレイブックで構成される制御ノードが、設定を管理対象ノードにプッシュします。

要件

• Ansible 2.12.0 以降が必要です。

• ほとんどの Debian および RHEL ベースの Linux ディストリビューション、および Windows をサポートしています。

  

  AppDynamics Ansible コレクションは、Linux でのみ、JBoss（Wildfly）および Tomcat の自動インストゥルメンテーションをサポートしています。

• Windows OS には Powershell 5.0 以降が必要です。
• Ansible 制御ノードで https://download-files.appdynamics.com および https://download.appdynamics.com から AppDynamics エージェントをダウンロードするためのネットワーク/ファイアウォールアクセス
• Ansible 制御ノードでは jq が必要です。手動でインストールするか（sudo アクセスが必要です）、playbook フォルダ内の install_jq.yaml プレイブックを実行することを推奨します。例：ansible-playbook install_jq.yaml --ask-become-pass -e 'ansible_python_interpreter=/usr/bin/python'
• 拡張エージェントロギング（DEBUG、TRACE など）を有効にする必要がある場合は、lxml が必要です。pip3 install lxml を使用して Ansible 制御ノードに手動でインストールするか、playbook フォルダの install_lxml.yaml プレイブックを実行することを推奨します。
• アプリケーションに基づいてエージェントのプレイブックをダウンロードします。

重要

• インストール後に複数のエージェントを同時に再起動すると、コントローラでパフォーマンスの問題が発生する可能性があります。アプリケーションを段階的に再起動することを推奨します。
• AppDynamics ダウンロードポータルからエージェントをダウンロードする場合は、20 のフォーク値を使用することを推奨します。より高いフォーク値にカスタムダウンロードパスを使用することができます。「カスタムダウンロードパス」を参照してください。

AppDynamics コレクションのインストール

1. Ansible 制御ノードで次のコマンドを使用して、Ansible Galaxy から AppDynamics コレクションをインストールします。初めてインストールする場合は、-force を追加しないでください。

   ansible-galaxy collection install --force appdynamics.agents

   CODE

2. （オプション）ローカルファイルサーバーをカスタムエンドポイントとして使用している場合は、次のコマンドを使用します。

   ansible-galaxy collection install ./appdynamics-agents-<version>.tar.gz

   CODE

3. ansible-playbook コマンドを使用して、管理対象マシンに AppDynamics エージェントをインストールおよび展開する設定でプレイブック（例：customer-playbook.yml）を作成します。

   Example

   $ ansible-playbook customer-playbook.yml

   CODE

4. （オプション）次のコマンドを使用して ansible.cfg ファイルを設定し、エージェントのインストールステータスをログに記録します。
    

   [defaults]
   callbacks_enabled=  appdynamics.agents.appd_agent_status

   CODE

エージェントを管理するためのツールは、エージェント インストール ディレクトリの外部に展開またはインストールされた拡張機能には影響しません。マシンエージェントの場合、エージェントを管理するためのツールにより、アップグレード後にマシンエージェントの拡張機能が再展開されます。使用する可能性がある拡張機能の潜在的な影響が不明な場合は、アカウントマネージャまたはカスタマー サクセス マネージャにお問い合わせください。また、サポートポータルを使用することもできます。

プレイブック

AppDynamics Ansible コレクションのプレイブックフォルダには、各エージェントタイプのサンプルプレイブックが含まれています。
コレクションのインストールフォルダにあるサンプルプレイブックを使用できます。

playbooks/vars ディレクトリには、enable_ssl、controller_port などの変化しない変数が含まれています。次の Java の例に示されているように、YAML ファイルをプレイブックに含めるか、プレイブックの変数を上書きすることができます。

インストールを続行する前に、Ansible の優先順位ルールを確認します。

AppDynamics コレクションをインストールすると、次のエージェントを使用できます。

カスタムエージェントのダウンロードパス

これは、.Net エージェント MSI には適用されません。

プレイブックが公式の AppDynamics ダウンロードポータルからエージェントファイルをダウンロードしないようにする場合は、プレイブックで次の変数を使用して、任意の場所からエージェントをインストールすることができます。

共通ロールの変数

変数	説明	適用可能なエージェント
agent_action	アップグレード、インストール、ロールバック、またはアンインストールを実行します。	すべて
agent_dir_permission.user	Linux 上の Java エージェントのファイル権限をユーザーに割り当てます。create_appdynamics_user が No に設定されている場合は、選択したユーザーとグループがすでにホストに存在している必要があります。	Java
agent_dir_permission.group	Linux 上の Java エージェントのファイル権限をグループに割り当てます。create_appdynamics_user が No に設定されている場合は、選択したユーザーとグループがすでにホストに存在している必要があります。	Java
agent_log_level	エージェントのログレベル。有効なオプションは、info、trace、debug、warn、error、fatal、all、および off です。この設定は、agent_loggers リストで指定されたすべてのロガーに適用されます。	Java、マシン、PHP
agent_loggers	ロガーのリストに対してログレベルを設定します。ロガー名はエージェントによって異なります。デフォルトでは、*、com.singularity、com に設定されています。ターゲットエージェントに固有のロガーでこの変数を更新します。/conf/logging ディレクトリ内の log4j ファイルを参照してください。	Java、マシン
agents_to_set_loggers_for	ログレベルの変更を適用するエージェントのリスト。たとえば、展開されたすべてのエージェントのログレベルを info に設定するには、この変数を java に初期化します。 エージェント展開の一部としてロガーロールを使用する場合は、この変数を設定しないでください。agent_type 変数が、インストール中にログレベルをどのように調整する必要があるかを決定するために使用されます。	Java、マシン
agent_type	AppDynamics エージェントのタイプ。たとえば、java のようになります。	すべて
agent_version	AppDynamics エージェントのバージョン。この値は、latest またはエージェントのバージョン（23.2.0 など）にすることができます。 AppDynamics は、カレンダーのバージョン管理を使用します。たとえば、Java エージェントが 2023 年 2 月にリリースされた場合、そのバージョンは 23.2.0 になります。	すべて
appdynamics_user	AppDynamics の機能ユーザー名。デフォルトは appdynamics です。	Java、マシン
application_name	アプリケーション名この変数は、すべての java ロールに必須です。	すべて
controller_account_name	AppDynamics コントローラのアカウント名。	すべて
controller_account_access_key	コントローラアカウントのアクセスキー。これは Vault に配置する必要があります。	すべて
controller_host_name	コントローラのホスト名。http(s) は含めません。	すべて
controller_port	コントローラポート。	すべて
create_appdynamics_user	Linux で AppDynamics 機能ユーザーを作成します。	Java、マシン
dir	エージェントファイルのベースディレクトリ。デフォルト：/tmp/appd/	すべて
enable_proxy	true に設定すると、エージェントのプロキシ設定がエージェント設定に適用されます。proxy_host および proxy_port の変数を割り当てます。	Java、.Net
enable_ssl	コントローラで SSL を有効にするかどうかを示します。	すべて
init_and_validate_agent_variables	この変数は、（ダウンロード URL とコントローラパラメータを設定する）共通ロールの初期化の実行を制御します。ロガーロールを（エージェントインストールの一部としてではなく）単独で使用する場合、この値は false にする必要があります。	Java、マシン
keep_backup	agent_action が uninstall のときに使用します。アンインストール後にエージェントのバックアップファイルを保持するには、true に設定します。デフォルト値は false です。	Apache、Java、マシン、Node.js、PHP、Python
linux_install_root	これを使用して、すべてのインストールされたエージェントおよびバックアップファイルが置かれるフォルダを設定します。たとえば、Java エージェントの場合、<linux_install_root>/java-agent と <linux_install_root>/backup/java-agent が作成されます。Linux のデフォルト値は /opt/appdynamics です。	Apache、Java、マシン、Node.js、PHP、Python
linux_custom_agent_install_path	これを使用して、エージェントのインストールパスを指定し、ルートディレクトリであるデフォルトのインストールパスを上書きします（linux_install_root を参照）。エージェントのバックアップはルートディレクトリに置かれ、この変数では設定されません。エージェントファイルはこのディレクトリにインストールされます。linux_install_root. のファイルを保存するには、このパスを指定しないでください。	Apache、Java、マシン、Node.js、PHP
max_agent_backup_count	エージェントごとに許可されるバックアップの最大数。デフォルト値は 1 です。	Java
node_name	java ロールの AppDynamics ノード名。	Apache、Java、マシン、Node.js、PHP、Python
proxy_host	エージェントデータをルーティングするプロキシのホスト名/IP アドレス。	Java、.Net
proxy_port	エージェントデータをルーティングするプロキシのホストポート番号。	Java、.Net
tier_name	AppDynamics の階層名。この変数は、すべての java ロールに必須です。	Apache、Java、マシン、Node.js、PHP、Python
windows_install_root	linux_install_root と同様で、Windows ホストで使用します。デフォルト値は C:/appdynamics です。	Apache、Java、マシン、Node.js、PHP、Python
windows_custom_agent_install_path	linux_custom_agent_install_path と同様で、Windows ホストで使用します。	Apache、Java、マシン、Node.js、PHP、Python

開始するには、エージェントを選択します。

Ansible® は米国およびその他の国における Red Hat, Inc. の登録商標です。