Javaエージェント構成プロパティ

Deployment Support

関連ページ：

• Javaエージェントの管理
• Javaエージェント設定にシステムプロパテイを使用する
• 動的な環境におけるJVMのインストゥルメント化

このページは、Splunk AppDynamics Java エージェント構成プロパティを参照しています。Java エージェントと同じマシンにマシンエージェントもインストールする場合は、「マシンエージェントのインストールのシナリオ」を参照してください。

エージェントとコントローラ間のコミュニケーションプロパティ

エージェントとコントローラ間のコミュニケーション プロパティを次に示します。

AWS インスタンス

appdynamics-aws-instance-enabled プロパティは、登録時にエージェントが AWS インスタンス ID をデフォルトで取得できるようにします。

Java エージェントが AWS インスタンスで実行されている場合、エージェントログには Agent AWS instance-id:<instance-id-of-host> が含まれます。それ以外の場合は、エージェントログに Agent AWS instance-id:null が含まれます。

このプロパティはデフォルトで有効になっていて、エージェントログには Agent AWS instance-id retrieval enabled: true が含まれます。プロパティを無効にするには、appdynamics.aws.instance.enabled=false を設定します。エージェントログには Agent AWS instance-id retrieval enabled: false が含まれます。

コントローラホスト

Splunk AppDynamics コントローラのホスト名または IP アドレス。値の例は、192.168.1.22、myhost、または myhost.example.com です。これは Splunk AppDynamics のブラウザベースのユーザーインターフェイスのアクセスに使用するホストと同じです。オンプレミスのコントローラの場合、コントローラをインストールしたときに構成したアプリケーション サーバー ホスト名の値を使用します。

コントローラポート

Splunk AppDynamics コントローラの HTTP(S) ポート。これは Splunk AppDynamics のブラウザベースのユーザーインターフェイスのアクセスに使用するポートです。

コントローラ SSL 対応プロパティが true に設定されている場合はコントローラの HTTPS ポートを指定し、それ以外の場合は HTTP ポートを指定します。「Controller SSL Enabled Property」を参照してください。

SSL構成プロパティ

コントローラSSL対応

trueに設定すると、エージェントがSSL (HTTPS) を使用してコントローラに接続するよう指定します。SSL対応がtrueの場合、コントローラポートのプロパティをコントローラのHTTPSポートに設定します。「Controller Port Property」を参照してください。

コントローラ キーストアパスワード

コントローラ証明書のパスワードのプレーンテキスト値。[Use Encrypted Credentials] が true の場合、パスワードを暗号化します。「エージェントの認証情報を暗号化する」を参照してください。

コントローラ キーストアパスワード

デフォルトでは、エージェントはエージェントホームの <agent_home>/<version>/conf ディレクトリにある cacerts.jks という名前の Java トラストストアファイルを探します。このプロパティを使用し、異なるJavaトラストストアファイルを使うコントローラSSL証明書の完全な検証を可能にします。「Javaエージェント用SSLの有効化」を参照してください。

デフォルトのSSL証明書検証の強制

SSL検証のデフォルトの動作をオーバーライドするのに使用。このプロパティには3つの状態があります。

• true：エージェントは、コントローラによって送信された証明書の完全な検証を強制的に実行します。これにより、エージェントは SSL 信頼チェーンを適用できます。パブリック証明機関（CA）がコントローラの SSL 証明書に署名した場合、この設定を使用します。「トラステッド CA 署名済み証明書を使用したオンプレミス SSL の有効化」を参照してください。
• false：エージェントは、証明書の最小限の検証を強制的に実行します。このプロパティはコントローラのSSL証明書の完全な検証を無効にします。
• unspecified：エージェントが実行する検証内容は、コンテキストに応じて次のようになります。
  • エージェントがオンプレミスコントローラに接続していて、cacerts.jks ファイルがある場合、cacerts.jks ファイルを使用して完全な検証が実行されます。
  • エージェントがオンプレミスコントローラに接続していて、cacerts.jks ファイルがない場合、最小限の検証が実行されます。

デフォルトの SSL 検証強制プロパティは、トランザクション分析のために Java エージェントをイベントサービスに接続する場合にも適用されます。「Javaエージェント用SSLの有効化」を参照してください。

Splunk AppDynamics エージェントの SSL プロトコル

「Agent and Controller Tenant Compatibility」にある SSL 互換性に関する表には、さまざまなバージョンの Java エージェントのデフォルト セキュリティ プロトコルが一覧で表示されています。ご使用のバージョンのエージェントのデフォルト セキュリティ プロトコルがコントローラと互換性がない場合、または介在するプロキシと互換性がない場合は、-Dappdynamics.agent.ssl.protocol システムプロパティを渡して次のセキュリティプロトコルのいずれかを構成します。

• [SSL]
• [TLS]
• TLSv1.2
• TLSv1.1

許可される TLS/SSL プロトコルの構成

TLS/SSL を介したエージェント通信により、エージェントは、JVM セキュリティサブシステムを初期化することにより、許可されるプロトコルのリストを設定します。既知の脆弱性により、Splunk AppDynamics はデフォルトで SSLv3 と TLSv1 プロトコルを除外します。

JVM の初期化後は、許可されるプロトコルのリストを変更できなくなります。エージェントが SSLv3 または TLSv1 プロトコルを無効にしないようにする場合は、次のプロパティを使用して、一方（またはカンマで区切って両方）のプロトコルを指定することにより、許可されるよう構成できます。

-Dappdynamics.agent.tls.allowedAlgorithms=SSLv3, TLSv1

このプロパティは、Java エージェントの 4.5.13 バージョンから適用されます。

無効な TLS/SSL プロトコルの設定

TLS/SSL を介したエージェント通信により、エージェントは JVM セキュリティサブシステムを初期化することにより、許可されるアルゴリズムのリストを設定します。

JVM の初期化後は、許可されるプロトコルのリストを変更できなくなります。エージェントが特定のアルゴリズムを有効にしないようにする場合は、次のプロパティを使用して、一方（またはカンマで区切って両方）のアルゴリズムを指定することにより、無効になるように設定できます。

-Dappdynamics.agent.tls.disabledAlgorithms=RSASSA-PSS,RSAPSS

Secure Credential Storeプロパティ

暗号化された認証情報を使用

[Use Encrypted Credentials] を有効にする前に、Secure Credential Store の初期化に関する手順について、「エージェントの認証情報を暗号化する」を参照してください。

[Use Encrypted Credentials] を「True」に設定し、エージェントが Secure Credential Store で暗号化された認証情報を使用するよう構成します。認証情報の暗号化の使用を有効化した場合、Credential Storeファイル名と難読化されたCredential Storeパスワードを指定しなければなりません。 

認証情報の暗号化の使用がtrueの場合、以下を暗号化する。

• アカウントアクセスキー
• コントローラ キーストアパスワード
• プロキシパスワード
  

Credential Storeファイル名

Secure Credential Storeキーストアへの絶対パス。「エージェントの認証情報を暗号化する」を参照してください。

Credential Storeパスワード

Secure Credential Storeの難読化されたキーストアのパスワード。「エージェントの認証情報を暗号化する」を参照してください。

エージェント識別プロパティ

自動命名

true に設定すると、Java エージェントはアプリケーションのノードに一意の名前を自動的に割り当てます。他のエージェント識別プロパティが別の設定で指定されていない場合、エージェントのティアとアプリケーションは自動的に命名されます。デフォルトの名前は MyApp、MyTier、application_server@host の形式になります。このプロパティを有効にした後は、必ず JVM を再起動してください。サーバーが再起動されるまで、ノード名はコントローラ UI に null として表示されます。

アプリケーション名

このJVMノードが属する合理的なビジネスアプリケーションの名前。これはアプリケーションサーバー上のデプロイメント名(ear/war/jar)ではないことにご注意ください。

構成された名前のビジネスアプリケーションが存在しない場合、自動的に作成されます。

ティア名

このJVMノードが属するティアの名前。これはアプリケーションサーバー上のデプロイメント名(ear/war/jar)ではないことにご注意ください。

JVM またはアプリケーションサーバー起動スクリプトに、-Dserver.tier のような、ティアを参照するシステムプロパティがすでにある場合、${server.tier} をティア名として使用できます。「Javaエージェント設定にシステムプロパテイを使用する」を参照してください。

エージェントは、最初にコントローラと接続したときにティアが存在しない場合、名前の付いたティアをコントローラに登録します。コントローラモデルに名前の付いたティアが存在する場合は、エージェントは既存のティアと関連付けられます。 

ノード名

ノードの名前。JVM が動的に作成される場合にシステムプロパティを使いノード名を設定する。

JVM またはアプリケーションサーバー起動スクリプトに、-Dserver.name のような、ノード名として使えるシステムプロパティがすでにある場合、${server.name} をノード名として使用できます。また、${server.name}_${host.name}.MyNode のような式を使ってノード名を定義できます。「Javaエージェント設定にシステムプロパテイを使用する」を参照してください。

一般的に、ノード名はビジネスアプリケーションおよび物理的なホスト内で一意でなければなりません。同じ物理マシン上で複数のノードに同じノード名を使用したい場合は、ユニークホストIDのプロパティを使って複数の仮想ホストを作成します。「Unique Host ID」を参照してください。

ノード名を再利用

このプロパティを true に設定して Splunk AppDynamics でノード名を再利用します。プロパティが true の場合、ノード名を指定する必要はありませんが、-Dappdynamics.agent.reuse.nodeName.prefix を使用してノード名プレフィックスを指定する必要があります。

ReuseNodeName/prefix およびノード名を使用すると、ReuseNodeName プロパティが優先されます。

このプロパティは、寿命が短い JVM が多数ある環境のモニタリングに役立ちます。true の場合、Splunk AppDynamics は新しい JVM の過去の JVM のノード名を再利用します。これにより、本質的には同一プロセスのノードが異なる時間で実行される場合に、AppDynamics 内で別の名前が付いたノードが時間の経過とともに急増するのを回避できます。実際の作業負荷に基づき新しい JVM の起動とシャットダウンが行われる z/OS 動的ワークロード マネージャ ベースの環境などがこの環境の一例です。

Splunk AppDynamics はノード名をアプリ、ティア、シーケンス番号を使い生成します。ノード名はプールされます。たとえば、ノードがパージされる（ノードの存続期間に基づく）と、シーケンス番号が再利用されます。

Javaエージェントは起動すると、コントローラに登録されてコントローラがノード名を生成するまで、コンソールに出力を記録します。ログをファイルに書き込むようにエージェントを構成するには、<agent_home>/<version_number>/conf/logging で log4j-unknown.xml を編集します。「動的な環境におけるJVMのインストゥルメント化」を参照してください。

コントローラは、ノードの保持期間プロパティに基づいてノード名を再利用します。

ノード名プレフィックスを再利用

ノード名を再利用するようにエージェントを構成する際に、このプロパティを使用し、コントローラがノード名を動的に生成するのに使用するプレフィックスを指定します。  

セルフサービス

プラットフォームに基づいて自動的にノードに名前を付けるようJavaエージェントを構成します。自動ノード命名を機能させるには、アプリケーション名とティア名を指定する必要があります。

アカウントプロパティ

Splunk AppDynamics コントローラがマルチテナントモードで実行している場合、このエージェントがコントローラの認証に使用するアカウント名とキーを指定します。

この情報は、<controller_home>/initial_account_access_info.txt ファイルから調べることも可能です。

コントローラがシングルテナントモードで実行している場合は、アカウントアクセスキーの構成だけが必要となります。コントロールインスタンス用の一意のアクセスキーは、UI の「2024-03-18_22-14-12_ライセンス使用状況の確認」ページで調べることができます。 

アカウント名

コントローラの認証に使用されるアカウント名。

アカウントアクセスキー

コントローラの認証に使用されるアカウントアクセスキー。認証情報の暗号化の使用がtrueの場合、パスワードを暗号化します。「エージェントの認証情報を暗号化する」を参照してください。

JVM システムプロパティまたは環境変数を介してアプリケーションキーを提供する場合は、シェルがそれらを解釈するのを防ぐために、アプリケーションキー内に含まれる可能性があるシェル特殊文字をすべて引用符で囲んでください。詳細については、シェルのドキュメントを参照してください。

コントローラ用プロキシプロパティ

プロキシプロパティを使用し、プロキシを通じてコントローラに接続するようにエージェントを構成する。 

プロキシ認証はエージェント SSL と同時に使用できません。SSL 上でプロキシを通してエージェントを接続するには、プロキシはオープンでなければなりません（エージェントを認証する必要はありません）。

プロキシホスト

プロキシホスト名またはIPアドレス

プロキシポート

プロキシHTTP(S)ポート

プロキシユーザー名

プロキシホストが認証したユーザー名

プロキシパスワード

プロキシホストにより認証されるユーザーのパスワードを含むファイルへの絶対パス。パスワードはファイルの最初の行になければなりません。

[Use Encrypted Credentialsuseencryptedpassword] が false の場合、パスワードをプレーンテキストで入力します。[Use Encrypted Credentials] が true の場合、パスワードを暗号化します。「エージェントの認証情報を暗号化する」を参照してください。

他のプロパティ

オーケストレーションの有効化

true に設定している場合、アプリケーションサーバーが Splunk AppDynamics オーケストレーション ワークフローにより作成されるコンピューティング クラウド インスタンスである場合には、コントローラホストとポートの自動検出が有効になります。「Controller Host Property」および「Controller Port Property」を参照してください。

クラウドコンピュート環境で、ワークフローでマシンの作成タスクが正しく動作するために自動検出は必要です。

このエージェントが存在するホストマシンが Splunk AppDynamics ワークフロー オーケストレーションで作成されない場合、このプロパティを false に設定する必要があります。

エージェントのランタイムディレクトリ

エージェントが実行時に書き込むすべてのファイル用のディレクトリを設定します。このプロパティが指定されると、すべてのエージェントログは<Agent-Runtime-Directory>/logs/node-nameに書き込まれ、トランザクション構成は<Agent-Runtime-Directory>/conf/node-nameディレクトリに書き込まれます。ログフォルダの場所は、appdynamics.agent.logs.dir プロパティを使用して上書きできます。

ログファイルをリダイレクト

ログが書き込まれる宛先ディレクトリを設定します。 

エージェントの conf ディレクトリのカスタムパス

エージェントのconfディレクトリにカスタムパスを設定します。 エージェントが静的構成ファイルを読み取る場所です。custom-activity-correlation.xml または app-agent-config.xml を変更する必要があり、エージェントのインストールが読み取り専用の場合に、他の場所から静的構成ファイルを読み取るようエージェントに指示します。

エージェント登録の強制

次の条件に当てはまる場合にのみ true に設定します。

• エージェントがUIから新しいアプリケーションまたはティアに移動され、かつ
• エージェント構成で新しいアプリケーション名またはティア名を指定して、その移動をオーバーライドしたい場合。

自動ノード名プレフィックス

このプロパティは、指定したプレフィックスを使いコントローラにノード名を自動的に生成させる場合に設定します。

コントローラは、指定したプレフィックスとUUIDサフィックスを連結してノード名を生成します。たとえば、プレフィックスを以下のように指定すると、

-Dappdynamics.agent.auto.node.prefix=JoannaAutoNode

以下のノード名が生成されます。

JoannaAutoNode_d39dbfc1-6f4b-4eb7-a788-c1c0135b6bcb

このプロパティは、ノード名プレフィックス再利用のプロパティと同様の機能を提供します。ただし、このプロパティはノード名の再利用と組み合わせて使用されるものではありません。そのような場合には、代わりにノード名プレフィックス再利用のプロパティを使用します。 

自動ログディレクトリのクリーンアップ

Java エージェントで古いノードディレクトリを自動的に削除する場合は、このプロパティを設定します。デフォルトでは、このプロパティは無効になっていて、0 に設定されています。

エージェントを再起動するたびに、エージェントは、プロパティで指定された過去数時間更新されていない古いノードディレクトリを削除します。たとえば、次のようにプロパティを設定します。

-appdynamics.agent.log.dir.threshold.hours=4

次回のエージェントの再起動時に、エージェントは過去 4 時間に更新されていないノードディレクトリを削除します。

controller-info.xml 内の要素：該当なし

システムプロパティ：-appdynamics.agent.log.dir.threshold.hours

型：整数

デフォルト：0

必須：いいえ

Cron/Batch JVM

このプロパティは、JVMがbatch/cronプロセスの場合にtrueに設定されます。このプロパティを使用して、シャットダウンする前にエージェントがメトリックを送信できるように、シャットダウンを遅らせます。

ユニークホストID

アプリケーションが異なるマシンで実行されているコントローラに表示されるように、単一の物理ホストまたはバーチャルマシンを論理的に分割する。管理しているインフラストラクチャ全体をとおして一意の値を文字列に設定する。文字列に空白文字は使用できません。アプリケーションエージェントが監視するアプリケーションに関連付けられたマシンエージェントがある場合、このプロパティをマシンエージェント上で同じ値に設定しなければなりません。「マシンエージェントのインストールのシナリオ」を参照してください。

エージェントのメタ情報

任意の情報をノードに関連付けできます。これは、ノードごとに正常性ルールまたはポリシーを適用するための基礎として使用できます。たとえば、meta-info プロパティに基づいて、テストエージェントとしてタグ付けされたエージェントへの適用から正常性ルールを除外できます。key;value 形式でプロパティを渡します（例："key1;value1;key2;value2"）。セミコロンは区切り文字として使用されるため、値として使用しないでください。

正常性ルールまたはポリシーで（組み込み meta-info プロパティとともに）プロパティを使用する際の詳細については、「正常性ルールの構成」または「ポリシーの設定」を参照してください。 

低エントロピー

PRNGアルゴリズムのシードに使用可能な低からゼロのエントロピーを使用して、システム内のエージェントのスタートアップに関する問題を解決します。デフォルトでは true に設定されています。システムプロパティ appdynamics.low.entropy が設定されている場合は、SecureRandom を介して NativePRNGNonBlocking アルゴリズムを使用します。Windows は NativePRNGNonBlocking をサポートしておらず、既存の Secure Random 実装を引き続き使用するため、この変更の影響を受けません。

分析エージェント

リモート（またはデフォルトでない）分析エージェントでトランザクション分析機能を使用する場合。「リモート分析エージェントのアプリケーション サーバ エージェントの有効化」を参照してください。

単純なホスト名の使用

デフォルトでは（uniqueHostId システムプロパティで上書きされない限り）、エージェントはリバース DNS ルックアップによって、それ自体が実行されている OS のホスト名を決定します。状況によっては、このホスト名がホスト名の完全修飾ドメイン名として設定されている場合があります。このプロパティが true に設定されている場合、エージェントはドメイン名を削除し、単純なホスト名を使用してホストを識別します。ホスト名が IP アドレスである場合（DNS ルックアップが失敗した場合に発生します）、文字列形式の完全な IP アドレスが使用されます。ホスト名は、マシンエージェントによって収集されたメトリックをアプリケーションノードにマッピングするために使用されます（「Unique Host ID Property」を参照）。

ダイナミックサービスの JAR 署名

True に設定すると、ダイナミックサービスの自動 JAR 署名が有効になります。また、ダイナミック サービス ワークフローの脆弱性を特定します。悪意のあるダイナミックサービスからのコードのロードと実行を防ぐためのチェックも提供します。
False に設定すると、JAR 署名が無効になります。

Java エージェントタグ

Java エージェントタグには、コントローラ 24.4 以降が必要です。コントローラのバージョンが 24.4 よりも古い場合は、タグを削除するか、-Dappdynamics.disable.tags=true システムプロパティを使用してタグを無効にする必要があります。サポートされていないコントローラでタグを有効にすると、Java エージェントはコントローラに登録されません。

タグは、アプリケーション、ティア、ノードなどのエンティティに関連付けられているキーと値のペアです。これらのタグは、コントローラ UI でアプリケーションリソースを見つけるのに役立つメタデータとして機能します。適切なカスタムタグを使用してエンティティに関連する問題にタグ付けすることで、エンティティに関連する問題の平均検出時間（MTTD）を短縮できます。コントローラにタグをインポートする方法については、「カスタムタグ API」を参照してください。

Java エージェントタグは、システムプロパティまたは環境変数を使用してエージェント登録時に定義できます。競合する場合は、環境変数がシステムプロパティよりも優先されます。これらのタグはコントローラ UI に送信され、タグベースのフィルタリングとタグベースの列を使用してデータをフィルタリングするのに役立ちます。タグ付け設定を変更した場合は、エージェントを再起動する必要があります。