Download PDF
Download page マシンエージェントの設定プロパティ.
マシンエージェントの設定プロパティ
このページでは、controller-info.xml
の要素、コマンドラインまたはスタートアップスクリプトでのシステムプロパティのオプション、環境変数(該当する場合)など、エージェントの構成プロパティについて説明します。エージェントシステムのプロパティは、使用するオペレーティングシステムとインストールパッケージに基づいて構成します。
エージェントは、エージェント構成プロパティの変更に応じて動的に更新されるため、エージェントの再起動は不要です。
システムプロパティの構文
- システムプロパティは、大文字と小文字が区別されます
- スペースを含む値は、二重引用符で囲む必要があります
リファレンス
.NET 互換モード
マシンエージェントと .NET エージェントがインストールされているサーバで、マシンメトリックまたはサーバメトリックを収集して表示する場合、このモードを有効にする必要があります。「.NET 互換モード」を参照してください。
controller-info.xml 内の要素:<dotnet-compatibility-mode>
システムプロパティ:
-Dappdynamics.machine.agent.dotnetCompatibilityMode
環境変数:該当なし
型:ブール型
デフォルト:false
必須:マシンエージェントと .NET エージェントがインストールされているサーバで、マシンメトリックまたはサーバメトリックを収集して表示する場合、このモードは必須です。
アカウントアクセスキー
コントローラの認証に使用されるアカウントアクセスキー。このキーはインストール時に生成され、コントローラ設定でライセンス情報を表示することでこのキーを確認できます。詳細については、ライセンス使用状況の確認を参照してください。
controller-info.xml 内の要素:<account-access-key>
システムプロパティ:-Dappdynamics.agent.accountAccessKey
環境変数: APPDYNAMICS_AGENT_ACCOUNT_ACCESS_KEY
型:文字列
デフォルト:なし
必須:4.1 より前のバージョンでは、このプロパティは、SaaS およびマルチテナント コントローラにのみ必要でした。バージョン 4.1 以降では、コントローラ通信に対してすべてのエージェントを認証するために、アカウント アクセス キー プロパティが必要です。
例: -Dappdynamics.agent.accountAccessKey=165e65645-95c1-40e3-9576-6a1424de9625
アカウント名
コントローラの認証に使用されるアカウント名。AppDynamics SaaS コントローラを使用する場合、アカウント名は AppDynamics から送信されるウェルカムメールで通知されます。
controller-info.xml 内の要素:<account-name>
システムプロパティ:-Dappdynamics.agent.accountName
環境変数: APPDYNAMICS_AGENT_ACCOUNT_NAME
型:文字列
デフォルト:なし
必須:AppDynamics SaaS コントローラとマルチテナントユーザには必須で、シングルテナントモード(デフォルト)では必須ではありません。エージェントが AppDynamics SaaS コントローラに登録されている場合、修復スクリプトの実行に使用される機能は無効になります。非 SaaS またはオンプレミスのコントローラに登録するようにエージェントの controller-info.xml
を再構成すると、エージェントは通常どおりローカルスクリプトを実行できます。
エージェント ロギング ディレクトリ
廃止されています。代わりに appdynamics.agent.logs.dir
を使用する必要があります。動作はエージェント ログ ディレクトリの <appdynamics.agent.logs.dir>/logs/
と同じです。
システムプロパティ:-Dappdynamics.agent.logging.dir
環境変数:該当なし
型:文字列
デフォルト:なし
必須:いいえ
エージェント ログ ディレクトリ
このエージェント インストレーションを使用するノードのログファイル用のログディレクトリを設定します。このプロパティが指定されている場合、すべてのエージェントログが <appdynamics.agent.logs.dir>/logs.
に書き込まれます。共通ディレクトリから複数のマシンエージェントを展開する場合は、「共通ディレクトリから複数のマシンエージェントをデプロイ」を参照してください。このプロパティは、appdynamics.agent.runtime.dir.
によって指定されたディレクトリを上書きします。appdynamics.agent.logs.dir
プロパティが指定されていない場合、ログディレクトリはマシンエージェントのインストールフォルダと同じレベルで作成されます。log4j.xml
ファイル内での変更は予期されていません。
システムプロパティ:-Dappdynamics.agent.logs.dir
環境変数:該当なし
型:文字列
デフォルト:なし
必須:いいえ
エージェントのランタイムディレクトリ
このエージェント インストレーションを使用するノードのすべてのランタイムファイル(ログなど)用のランタイムディレクトリを設定します。このプロパティを指定すると、すべてのエージェントログが <agent-runtime-dir>/logs/node-name
に書き込まれます。共通ディレクトリから複数のマシンエージェントを展開する場合に使用します。詳細については、共通ディレクトリから複数のマシンエージェントをデプロイを参照してください。
システムプロパティ:-Dappdynamics.agent.runtime.dir
環境変数:該当なし
型:文字列
デフォルト:なし
必須:いいえ
コンテナ プロセス セレクタ ブラックリストの正規表現
この正規表現と一致するプロセスがあるコンテナは無視され、コントローラに登録されません。
システムプロパティ:-Dappdynamics.docker.container.process.selector.blacklist.regex
環境変数:APPDYNAMICS_DOCKER_CONTAINER_PROCESS_SELECTOR_BLACKLIST_REGEX
型:文字列
デフォルト:なし
必須:いいえ
コントローラホスト
これは AppDynamics コントローラのホスト名または IP アドレスです(例:192.168.1.22、myhost、または myhost.abc.com)。これは AppDynamics のブラウザベース ユーザ インターフェイスのアクセスに使用されるホストと同じです。
controller-info.xml 内の要素:<controller-host>
システムプロパティ:-Dappdynamics.controller.hostName
環境変数:APPDYNAMICS_CONTROLLER_HOST_NAME
型:文字列
デフォルト:なし
必須:オーケストレーションの有効化プロパティが false の場合は必須。
オーケストレーションの有効化が true で、エージェントが AppDynamics ワークフローによって作成されるコンピューティング クラウド インスタンスに展開されている場合、自動検出値をオーバーライドする場合を除き、コントローラホストを設定しないでください。「Enable Orchestration Property」を参照してください。
コントローラキーストアのファイル名
デフォルトでは、エージェントは、エージェントホームの conf
ディレクトリにある cacerts.jks
という名前の Java トラストストアファイルを探します。このプロパティを使用し、異なるJavaトラストストアファイルを使うコントローラSSL証明書の完全な検証を可能にします。「.Machine Agent Configuration Properties v22.1」を参照してください。
controller-info.xml 内の要素:<controller-keystore-filename>
システムプロパティ:該当なし
環境変数:該当なし
型:文字列
デフォルト:なし
必須:いいえ
コントローラ キーストア パスワード
コントローラ証明書のパスワードのプレーンテキストまたは暗号化された値。パスワードを暗号化または難読化するには、「エージェントの認証情報を暗号化する」を参照してください。
controller-info.xml 内の要素:<controller-keystore-password>
システムプロパティ:該当なし
環境変数:該当なし
型:文字列
デフォルト:なし
必須:いいえ
コントローラポート
AppDynamicsコントローラのHTTP(S) ポート。これはAppDynamicsのブラウザベースユーザーインターフェースのアクセスに使用するポートと同じです。コントローラ SSL 対応プロパティが true に設定されている場合はコントローラの HTTPS ポートを指定し、それ以外の場合は HTTP ポートを指定します。「Controller SSL Enabled Property」を参照してください。
controller-info.xml 内の要素:<controller-port>
システムプロパティ:-Dappdynamics.controller.port
環境変数: APPDYNAMICS_CONTROLLER_PORT
型:正の整数
オンプレミスのデフォルト:HTTP の場合は 8090、HTTPS の場合は 8181。
SaaS のデフォルト:SaaS コントローラサービスの場合は、HTTPS 接続にポート 443 を使用します。
必須:オーケストレーションの有効化プロパティが false の場合は必須。
オーケストレーションの有効化が true で、エージェントが AppDynamics ワークフローによって作成されるコンピューティング クラウド インスタンスに展開されている場合、自動検出値をオーバーライドする場合を除き、コントローラポートを設定しないでください。「Enable Orchestration Property」を参照してください。
コントローラSSL対応
エージェントが SSL(HTTPS)を使用してコントローラに接続するかどうかを指定します。SSL対応がtrueの場合、コントローラポートのプロパティをコントローラのHTTPSポートに設定します。「Controller Port Property」を参照してください。
controller-info.xml 内の要素:<controller-ssl-enabled>
システムプロパティ:-Dappdynamics.controller.ssl.enabled
環境変数:APPDYNAMICS_CONTROLLER_SSL_ENABLED
型:ブール型
デフォルト:false
必須:いいえ
ノードが存在しない場合は作成する
マシンエージェントがコントローラに登録されるときに、APM ノードを強制的に作成します。
controller-info.xml 内の要素: <create-node-if-absent>
システムプロパティ:-Dappdynamics.machine.agent.registration.createNodeIfAbsent
環境変数:該当なし
型:ブール型
デフォルト:true
必須:いいえ。controller-info.xml
ファイルでアプリケーション/階層/ノードを設定する場合(既存のアップグレードまたは偶発的に)、このフラグを false に設定することで、マシンエージェントで APM ノードが作成されないようにすることができます。「マシンエージェントのインストールのシナリオ」を参照してください。
Docker の可視性の有効化
エージェントで Docker の可視性を有効にするには、controller-info.xml
設定に docker-enabled 要素を手動で追加し、フラグを true
に設定します。
controller-info.xml 内の要素:<docker-enabled>true</docker-enabled>
システムプロパティ:-Dappdynamics.docker.enabled
環境変数:APPDYNAMICS_DOCKER_ENABLED
型:ブール型
デフォルト:false
必須:はい
HTTP リスナーの有効化
このプロパティを true
に設定すると、マシンエージェントの HTTP リスナーが有効になります。その HTTP リスナーを使用して、マシンエージェントにメトリックを送信できます。マシンエージェントを介してメトリックをレポートするには、sysout
を介してエージェントにパイプする代わりに、エージェントに対して HTTP コールを行います。
controller-info.xml 内の要素:該当なし
システムプロパティ:-Dmetric.http.listener
環境変数:該当なし
型:ブール型
デフォルト:false
必須:いいえ
オーケストレーションの有効化
true
に設定すると、マシンエージェントのワークフロータスクの実行が有効になります。また、アプリケーションサーバが AppDynamics オーケストレーション ワークフローにより作成されるコンピューティング クラウド インスタンスの場合、コントローラホストとポートの自動検出が有効になります。クラウド コンピューティング環境でのワークフローで、マシンの作成タスクを正しく実行するために自動検出が必要です。マシンエージェントは、オーケストレーションが有効になっている場合にのみタスクの実行をポーリングします。このエージェントが存在するホストマシンが AppDynamics ワークフロー オーケストレーションで作成されない場合、このプロパティを false
に設定する必要があります。「Controller Host Property」および「Controller Port Property」を参照してください。
controller-info.xml 内の要素:<enable-orchestration>
システムプロパティ:該当なし
環境変数:該当なし
型:ブール型
デフォルト:false
必須:いいえ
デフォルトの SSL 証明書検証の強制
SSL 検証のデフォルトの動作をオーバーライドするために使用します。
このプロパティには、次の 3 つの状態があります。
true:エージェントは、コントローラによって送信された証明書の完全な検証を実行します。これにより、エージェントは SSL 信頼チェーンを適用できます。パブリック認証局(CA)がコントローラの SSL 証明書に署名した場合、この設定を使用します。
false:エージェントは、証明書の最小限の検証を実行します。このプロパティはコントローラのSSL証明書の完全な検証を無効にします。SaaS証明書の検証が失敗した場合にこの設定を使用。
未指定:エージェントが実行する検証内容は、コンテキストに応じて次のようになります。
- エージェントが SaaS コントローラに接続している場合、完全な検証が実行されます。
- エージェントがオンプレミスコントローラに接続していて、
cacerts.jks
ファイルがある場合、cacerts.jks ファイルを使用して完全な検証が実行されます。 - エージェントがオンプレミスコントローラに接続していて、
cacerts.jks
ファイルがない場合、最小限の検証が実行されます。
controller-info.xml 内の要素:該当なし
システムプロパティ:-Dappdynamics.force.default.ssl.certificate.validation
環境変数:該当なし
型:ブール型
デフォルト:なし
必須:いいえ
動的モニタリングモード(DMM)の有効化
このオプションを有効にすると、エージェントは、コントローラでそのエージェントに対して指定されている動的モニタリングモードに基づいてメトリックをレポートします。このオプションを無効にすると、エージェントは、そのローカル設定に基づいてすべてのメトリックをレポートします。コントローラの DMM 設定は影響しません。使用可能なすべてのメトリックを常時収集する必要があるミッションクリティカルなサーバとその他のマシンに対してのみ、エージェントで DMM を無効にすることをお勧めします。詳細については、動的モニタリングモードとサーバの可視性を参照してください。
controller-info.xml 内の要素:<dynamic-monitoring-enabled>
システムプロパティ:appdynamics.machine.agent.dynamicMonitoring.enabled
環境変数:APPDYNAMICS_DYNAMIC_MONITORING_ENABLED
型:ブール型
オンプレミスのデフォルト:True
SaaS のデフォルト:True
必須:いいえ
HTTP リスナーポート
マシンエージェントの HTTP リスナーを有効にするには、HTTP リスナーポートも指定する必要があります。
controller-info.xml 内の要素:該当なし
システムプロパティ:-Dmetric.http.listener.port
環境変数:該当なし
型:数値
デフォルト:8293
必須:HTTP リスナーが有効になっている場合のみ必須。
Log4j
ロギング機能は Apache Log4j2 を介して実行されます。log4j 構成のカスタムロケーションを指定するには、このプロパティを使用します。この場合、すべてのファイルの宛先が有効であり、絶対パスが含まれていることを確認する必要があります。
controller-info.xml 内の要素:該当なし
システムプロパティ:-Dlog4j.configurationFile
環境変数:該当なし
型:数値
デフォルト:なし
必須:いいえ
マシン階層
この機能を使用するには、サーバの可視性のライセンスが必要です。
この設定では、サーバへの階層パスを指定することにより、サーバを任意の階層にグループ化できます。サーバ階層は、メトリックブラウザとサーバダッシュボードに表示されます。サーバ階層は、正常性ルールでマシンのサブグループを選択する場合にも使用されます。パスの最後の要素は、サーバ名(任意の名前)を示します。この名前は、サーバリストに名前として表示されます。パスにスペースが含まれている場合は、二重引用符で囲む必要があります。詳細については、マシンエージェント階層を参照してください。
controller-info.xml 内の要素:<machine-path>
システムプロパティ:-Dappdynamics.machine.agent.hierarchyPath
環境変数:APPDYNAMICS_MACHINE_HIERARCHY_PATH
型:「|」(縦棒)で区切られたパス要素による ASCII 文字列。
デフォルト:Unique Host ID で指定された値。マシン階層の最後の部分が空の場合、一意のホスト ID はマシン名です。たとえば、マシン階層が「Data Center 1|Rack 2|」で、一意のホスト ID が「Host ID 3」の場合、マシン階層は「Data Center 1|Rack 2|Host ID 3」になります。
必須:いいえ
制限:最後のパイプ(パイプ自体を含まない)までのマシンパスを構成する文字の長さは、95 文字以下でなければなりません。
例:
- システムプロパティ:-
Dappdynamics.machine.agent.hierarchyPath= "Data Center 1|Rack 2|Machine3"
controller-info.xml:
<machine-path> "Data Center 1|Rack 2|Machine3" </machine-path>
CODE環境変数:
APPDYNAMICS_MACHINE_HIERARCHY_PATH="Data Center 1|Rack 2|Machine3
プロキシホスト
プロキシホスト名またはIPアドレスHTTP プロパティは、http と https の両方のプロキシ設定で機能します。プロキシ認証を SSL で使用することはできません。
controller-info.xml 内の要素:該当なし
システムプロパティ:
-Dappdynamics
.http.proxyHost
環境変数:該当なし
型:文字列
デフォルト:なし
必須:プロキシを使用してコントローラに接続する場合は必須です。それ以外の場合は必須ではありません。
プロキシ パスワード ファイル
プロキシホストにより認証されるユーザーのパスワードを含むファイルへの絶対パス。パスワードはファイルの最初の行になければなりません。
[<use-encrypted-credentials>]
が false に設定されている場合、パスワードをプレーンテキストで入力します。[<use-encrypted-credentials>]
が true に設定されている場合は、パスワードを暗号化します。「エージェントの認証情報を暗号化する」を参照してください。
controller-info.xml 内の要素:該当なし
システムプロパティ:-Dappdynamics.http.proxyPasswordFile
環境変数:該当なし
型:文字列
デフォルト:なし
必須:いいえ
例:-Dappdynamics.http.proxyPasswordFile=/path/to/file-with-password
プロキシポート
プロキシHTTP(S)ポートプロキシホスト名または IP アドレス。HTTP プロパティは、http と https の両方のプロキシ設定で機能します。デフォルトのポートは 8090(HTTP)と 443(HTTPS)です。
controller-info.xml 内の要素:該当なし
システムプロパティ:
-Dappdynamics.http.proxyPort
環境変数:該当なし
型:正の整数
デフォルト:なし
必須:プロキシを使用してコントローラに接続する場合は必須。それ以外の場合は、必須ではありません。
プロキシユーザ名
プロキシホストが認証したユーザー名
controller-info.xml 内の要素:該当なし
システムプロパティ:-Dappdynamics.http.proxyUser
環境変数:該当なし
型:文字列
デフォルト:なし
必須:いいえ
サーバの可視性の有効化
エージェントでサーバーの可視性を有効にします。これには、サーバの可視性のライセンスが必要です。
controller-info.xml 内の要素:<sim-enabled>
システムプロパティ:-Dappdynamics.sim.enabled
環境変数: APPDYNAMICS_SIM_ENABLED
型:ブール型
デフォルト:false
必須:サーバの可視性を有効にする場合は必須です。「サーバの可視性の有効化」を参照してください。
Service Availability の更新間隔
この設定は、サービスの可用性の定期的なイベントをコントローラに送信する間隔(ミリ秒単位)を制御します。「サービスの可用性」を参照してください。
controller-info.xml 内の要素: <sam-event-update-interval-millis>
システムプロパティ:-Dappdynamics.machine.agent.sam.event.updateIntervalMillis
環境変数:該当なし
型:正の整数
デフォルト:300000 ms(5 分)
必須:いいえ
一意のホスト ID
このプロパティは、単一の物理ホストまたは仮想マシンを論理的にパーティション化します。マシンエージェントのインストールのコンテキストでは、一意のホスト ID プロパティは必要ありません。ただし、一意のホスト ID を定義しない場合、マシンエージェントは Java API を使用してホスト ID を取得します。API からの結果は不整合となる可能性があるため、マシンエージェントが再起動されるたびに同じ JVM が同じマシンに対して異なる値を返すことがあります。この問題を回避するために、AppDynamics では UI に表示するホスト ID に一意のホスト ID の値を設定することを推奨しています。
controller-info.xmlのエレメント:<unique-host-id>
システムプロパティ:-Dappdynamics.agent.uniqueHostId
環境変数:APPDYNAMICS_AGENT_UNIQUE_HOST_ID
型:スペースなしの ASCII 文字列で、管理対象インフラストラクチャ全体で一意である必要があります。
デフォルト:なし
必須:任意、ただし推奨。
単純なホスト名の使用
デフォルトでは(uniqueHostId
システムプロパティで上書きされない限り)、エージェントはリバース DNS ルックアップを使用して、それ自体が実行されている OS のホスト名を決定します。状況によっては、このホスト名がホスト名の完全修飾ドメイン名として設定されている場合があります。このプロパティが true
に設定されている場合、エージェントはドメイン名を削除し、単純なホスト名を使用してホストを識別します。ホスト名が IP アドレスである場合(DNS ルックアップが失敗した場合に発生します)、文字列形式の完全な IP アドレスが使用されます。ホスト名は、マシンエージェントが収集したメトリックをアプリケーションノードにマッピングするために使用されます。「一意のホスト ID プロパティ」を参照してください。
controller-info.xml 内の要素:<use-simple-hostname>
型:ブール型
デフォルト:false
必須:いいえ
例:このプロパティを true に設定すると、「server.mydomain.com
」は「server」になります。
独立したマシンエージェントのインストールシナリオ
通常、AppDynamics アプリケーション エージェントがインストールされていないサーバにマシンエージェントをインストールする場合にのみ、次のプロパティを使用します。
アプリケーション名
このJVMノードが属する合理的なビジネスアプリケーションの名前。これはアプリケーションサーバ上のデプロイメント名(ear/war/jar)ではありません。設定した名前のビジネスアプリケーションが存在しない場合、自動的に作成されます。
controller-info.xml 内の要素:<application-name>
システムプロパティ:-Dappdynamics.agent.applicationName
環境変数: APPDYNAMICS_AGENT_APPLICATION_NAME
型:文字列
デフォルト:なし
必須:いいえ。「マシンエージェントのインストールのシナリオ」を参照してください。
ノード名
JVM ノードの名前。指定しない場合、デフォルトでは、マシンエージェントの Node1
になります。
controller-info.xml 内の要素:<node-name>
システムプロパティ:-Dappdynamics.agent.nodeName
環境変数: APPDYNAMICS_AGENT_NODE_NAME
型:文字列
デフォルト:なし
必須:いいえ。「マシンエージェントのインストールのシナリオ」を参照してください。
階層名
この JVM ノードが属する論理階層の名前。これはアプリケーションサーバ上のデプロイメント名(ear/war/jar)ではありません。設定した名前の階層が存在しない場合、自動的に作成されます。
controller-info.xml 内の要素:<tier-name>
システムプロパティ:-Dappdynamics.agent.tierName
環境変数: APPDYNAMICS_AGENT_TIER_NAME
型:文字列
デフォルト:なし
必須:いいえ。「マシンエージェントのインストールのシナリオ」を参照してください。