APM Javaエージェントのプロビジョニング
APM Javaエージェントのダウンロードが完了したら、APM Javaエージェント・ソフトウェアのプロビジョニングに進むことができます。
次のステップを実行します:
- アプリケーション・サーバーがインストールされているホストに接続し、ダウンロードしたAPM Javaエージェント・ソフトウェア・ファイルを任意の場所にコピーします。
アプリケーション・サーバーをインストールしたユーザーとしてログインし、アプリケーション・サーバー・ユーザーが、APM Javaエージェントをダウンロードまたはコピーするディレクトリに対する読取りおよび書込み権限を持っていることを確認します。
- アプリケーション・サーバーをインストールしたユーザーとしてログインしていることを確認し、APM Javaエージェント・ソフトウェアをダウンロードまたはコピーしたディレクトリに移動します。APM Javaエージェントをホストするディレクトリに対する読取りおよび書込み権限が必要です。
- APM Javaエージェントをプロビジョニングするために指定する必要がある次の必須の引数を確認します。
-service-name
: モニターされているサービスの名前。この引数を使用すると、トレース・エクスプローラ・ユーザー・インタフェースで、サービスでフィルタしてトレースを表示できます。-destination
: APM Javaエージェントがプロビジョニングされる宛先ディレクトリ。これは、前提条件タスクの一部として設定した、アプリケーション・サーバーの宛先ディレクトリを指す変数にすることが理想です。たとえば、Oracle WebLogic Serverドメインの場所に対応する$DOMAIN_HOME
などです。マイクロサービスの場合、宛先ディレクトリは標準のホーム・ディレクトリまたは空のディレクトリにできます。-private-data-key
: APMドメインの作成時に生成される、APM Javaエージェント(プライベートdataKey)によって使用されるエージェント・インストール・キー。-data-upload-endpoint
: APMドメインの作成時に生成されるdataUploadEndpoint URL。
プライベートdataKeyおよびdataUploadEndpointの詳細は、データ・アップロード・エンドポイントおよびデータ・キーの取得を参照してください。
APM Javaエージェントをプロビジョニングするときに、追加の引数を指定できます。これらの引数およびそれらが役立つシナリオの詳細は、プロキシ引数の指定を参照してください。
provision-agent
引数のヘルプ情報を表示するには、次のコマンドを実行します。java -jar ./apm-java-agent-installer-<version>.jar provision-agent -help
詳細は、ヘルプの使用情報を参照してください。
- 前のステップで説明した必須の引数を指定し、次の
java
コマンドを実行することにより、エージェントをプロビジョニングします:java -jar ./apm-java-agent-installer-<version>.jar provision-agent -service-name=<Name of the Service> -destination=<Destination_Directory> -private-data-key=<Agent installation key generated during APM domain creation> -data-upload-endpoint=<dataUploadEndpoint URL generated during APM domain creation>
次に例を示します:
java -jar ./apm-java-agent-installer-1.1.jar provision-agent -service-name=apm_service -destination=$DOMAIN_HOME -private-data-key=IMWJ5UN2C6YOLQSUZ5Q7IGN3QACF4AZD -data-upload-endpoint=https://dataUploadEndpoint.com
java
コマンドの実行時に、APM Javaエージェントが正常にプロビジョニングされた場合:Action [provision-agent] completed successfully
というメッセージが表示されます。oracle-apm-agent
ディレクトリが宛先ディレクトリ内に作成されます。たとえば、$DOMAIN_HOME/oracle-apm-agent
です。oracle-apm-agent
ディレクトリには次のものが含まれます:bin
: アグリゲータのスタータが含まれます。bootstrap
: APM Javaエージェントをデプロイするために-javaagent
コマンドで使用されるエージェント起動.jar
ファイルが含まれます。config
: 編集可能なグローバル構成ファイルが含まれます。このディレクトリには次のものが含まれます:- APM Javaエージェント構成引数が含まれる
AgentConfig.properties
ファイル。 - プローブに関連する構成情報が含まれる
ProbeConfig.acml
ファイル。
- APM Javaエージェント構成引数が含まれる
install
:<release-version>/config
ディレクトリが含まれます。これには、APM Javaエージェント・バイナリ・ファイルとデフォルト構成ファイルがあります。このディレクトリ内のファイルは変更しないでください。version
: APM Javaエージェントのリリース・バージョンおよびアクティブ化の日付に関する情報を含むバージョン・ファイル。
java
コマンドが終了したが、APM Javaエージェントが正常にプロビジョニングされていない場合は、ApmAgentInstall.log
ファイルおよびアプリケーション・サーバーの出力ログでエラーの詳細を確認して、問題を修正できます。
ヘルプ使用情報
ヘルプ情報およびエージェントをプロビジョニングする際に使用可能なオプションのリストを表示するには、-help
オプションを使用します。
java -jar ./apm-java-agent-installer-<version>.jar provision-agent -help
例:
java -jar ./apm-java-agent-installer-<version>.jar provision-agent -help
Usage:
apm-java-agent-installer-<version>.jar provision-agent [options ...]
options:
-service-name=<service name>
(Required) Name of the service being monitored.
-destination=<path>
(Required) Path to create Agent home directory. The Agent software will be
deployed to a 'oracle-apm-agent' sub-directory in the specified path.
-private-data-key=<private_data_key>
(Required) APM Agent private
data key for Appserver Agents. This property
is required for the APM Agent to connect to the Oracle APM Cloud, and it
is specific to your APM Cloud Domain.
-data-upload-endpoint=<https://host:port>
(Required) Endpoint of Oracle APM Cloud. This property is required for the
APM Agent to connect to the Oracle APM Cloud, and it is specific to your
APM Cloud Domain.
-enable-browser-agent-injection
Enables the APM Agent to automatically inject the browser agent into HTML
pages. Make sure '-public-data-key' is also set, otherwise injection will
not be enabled until one is provided.
-public-data-key=<public_data_key>
APM Agent public data key for Appserver Agents. This property is required
for the injected browser agent to connect to the Oracle APM Cloud, and it
is specific to your APM Cloud Domain.
-activation-date=<YYYY-MM-DD>
To stage newly installed Agent, and defer Agent running until Appserver
restart on or later than specified date.
-property=<key=value>
Agent specific (i.e. starting with 'com.oracle.apm.agent') configuration
properties. Multiple instances of -property can be specified.
Alternatively, you can add these properties to the
"AgentConfig.properties" file located in the Agent config directory
(oracle-apm-agent/config/<version>).
-overwrite
Overwrite Agent deployment.
Example:
- Deploy Agent to user home directory
provision-agent -service-name=myservice -destination=/home/user
-private-data-key=12345 -data-upload-endpoint=https://<endpoint>
- Deploy Agent to user home directory with additional properties
provision-agent -service-name=myservice -destination=/home/user
-private-data-key=12345 -data-upload-endpoint=https://<endpoint>
-property=com.oracle.apm.agent.logging.level=WARNING
または、APMエージェントのダウンロード、プロビジョニングおよびデプロイの支援のために、APMエージェントのインストール・ウィザードを使用できます。これは、APMエージェントのダウンロード・ページの上部にあります。