第3章 Java アプリケーションの設定

Cryostat Operator を使用して Cryostat エージェントを自動的に設定できます。または、必要に応じて、Cryostat エージェントを手動で設定することもできます。

この自動設定機能の一部として、Cryostat は、作成時に Pod を変更して Cryostat エージェントを注入する mutating admission webhook を使用します。また、webhook は、選択された Cryostat インスタンスに自動的に接続するようにエージェントを設定します。この場合、必要な cryostat.io/name および cryostat.io/namespace ラベルを含む Pod のみが webhook を呼び出すため、任意の Pod での Cryostat エージェントのセットアップが簡素化されます。さらに、Operator は、これらのラベルが Cryostat インスタンスのターゲット namespace のリスト内のアプリケーションデプロイメントで指定されている場合にのみ動作します。それ以外の場合は、セキュリティー上の理由から、Operator はアプリケーションがこの Cryostat インスタンスと通信するように設定しません。

webhook は、Cryostat エージェントのコンテナーベースのディストリビューション (cryostat-agent-init) を使用して、選択した Pod へのエージェントの自動設定と注入を行います。webhook が cryostat-agent-init コンテナーイメージを使用するため、ユーザーは Red Hat Maven リポジトリーからエージェント JAR ファイルをダウンロードする必要がなくなります。

Cryostat Operator がエージェントを自動的に設定できるようにする方法の詳細は、Cryostat Operator によるエージェントの自動設定の有効化 を参照してください。

Red Hat build of Cryostat は、エージェントを手動で設定するために、Cryostat エージェントの JAR ファイルを 2 種類配布しています。

これらのエージェント JAR ファイルは、Red Hat Maven リポジトリー からダウンロードできます。

Cryostat エージェントは、要件に応じて、静的または動的な方法を使用して JVM に割り当てることができます。

Cryostat Operator を使用してエージェントを自動的に設定する場合、Operator がすべての設定タスクを処理し、OpenShift Container Platform はアプリケーションを自動的に再デプロイします。

詳細は、Cryostat エージェントを使用するためのアプリケーションの設定 を参照してください。

この動的割り当て機能には、以下の要件があります。

動的割り当て機能は、JVM が起動するたびにエージェントを割り当てる必要がない、アドホックな 1 回限りのプロファイリングまたはトラブルシューティングワークフローをサポートします。動的割り当ては、エージェントを割り当てる目的でアプリケーションの再設定を行うことができない場合や再設定しない場合に適しています。エージェントはアプリケーションを再起動せずに実行中の JVM に割り当てることができるため、アプリケーションのダウンタイムも発生しません。

詳細は、JVM への動的割り当てのスタンドアロンプロセスとして Cryostat エージェントを起動する を参照してください。

エージェント JAR ファイルをワークロードアプリケーションに含めるオプションは、エージェントの自動設定を使用するか手動設定を使用するか、および JVM への割り当てを静的にするか動的にするかによって異なります。

エージェントを手動で設定することを選択した場合は、次の 2 つの方法のいずれかで Cryostat エージェントの設定プロパティーを指定できます。

上記のリストでは、Cryostat エージェントで使用可能な設定プロパティーの一部だけを説明しています。エージェントプロパティーの完全なリストは、Agent Properties を参照してください。

Cryostat Operator がエージェントを自動的に設定できるようにするには、アプリケーションデプロイメントに特定のラベルを追加する必要があります。

Cryostat Operator が、アプリケーションデプロイメントに cryostat.io/name および cryostat.io/namespace ラベルがあることを検出すると、Operator は cryostat-agent-init を使用して、エージェント JAR ファイルを含むボリュームをこのアプリケーションにマウントします。この場合、Operator は、Cryostat インスタンスのターゲット namespace のリスト内のアプリケーションデプロイメントでこれらのラベルが指定されている場合にのみ動作します。それ以外の場合は、セキュリティー上の理由から、Operator はアプリケーションがこの Cryostat インスタンスと通信するように設定しません。

Cryostat エージェントをすでに実行中のアプリケーション JVM に動的に割り当てる場合は、エージェントをスタンドアロン Java プロセスとして起動できます。

上記のコマンドを実行すると、エージェントプロセスは Attach プロバイダーを使用して、指定された PID を検索します。指定された PID が見つかった場合、エージェントプロセスはこの PID に割り当てられ、エージェントの JAR ファイルをこの JVM にロードしようとします。その後、この JVM が通常のエージェント起動プロセスにブートストラップします。

以下に例を示します。

$ java -jar target/cryostat-agent-0.5.0.redhat-00001-shaded.jar \
-Dcryostat.agent.baseuri=<cryostat_server_url> \
-Dcryostat.agent.callback=<cryostat_agent_url> \
-Dcryostat.agent.authorization=Bearer <authorization_value> \
--smartTrigger=[ProcessCpuLoad>0.2]~profile \
@/deployment/app/moreAgentArgs \
1234

使用可能なオプションとその動作の詳細を参照するには、java -jar target/<filename>.jar -h ヘルプコマンドを実行してください。<filename> は、コピーした “shaded” エージェント JAR ファイルの名前を表します。

Cryostat エージェントをスタンドアロンプロセスとして起動する場合は、前の例のように、-jar <path_to_jarfile> 引数の 後 に、遅延バインディング設定オプションの -D フラグを指定してください。ここでは -D フラグの位置が重要です。

前の例のように、cryostat.agent.baseuri、cryostat.agent.callback、cryostat.agent.authorization などの必要なエージェントプロパティーが、エージェントランチャーの設定オプションとして指定されたことを確認してください。設定プロパティーの詳細は、エージェント設定プロパティー を参照してください。