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

手順

1. Cryostat エージェントをインストールします。アプリケーションのビルドに応じて、次のオプションのいずれかを選択します。

   • Maven の使用:

     アプリケーションの pom.xml ファイルを Cryostat エージェントの JAR ファイルの情報で更新します。

     pom.xml の例

     <project>
       ...
       <repositories>
         <repository>
           <id>redhat-maven-repository</id>
           <url>https://maven.repository.redhat.com/earlyaccess/all/</url>
         </repository>
       </repositories>
       ...
       <build>
         <plugins>
           <plugin>
             <artifactId>maven-dependency-plugin</artifactId>
             <version>3.3.0</version>
             <executions>
               <execution>
                 <phase>prepare-package</phase>
                 <goals>
                   <goal>copy</goal>
                 </goals>
                 <configuration>
                   <artifactItems>
                     <artifactItem>
                       <groupId>io.cryostat</groupId>
                       <artifactId>cryostat-agent</artifactId>
                       <version>0.3.0.redhat-00001</version>
                       <classifier>shaded</classifier>
                     </artifactItem>
                   </artifactItems>
                   <stripVersion>true</stripVersion>
                 </configuration>
               </execution>
             </executions>
           </plugin>
         </plugins>
         ...
       </build>
       ...
     </project>

     次回アプリケーションをビルドするときに、Cryostat エージェント JAR ファイルが target/dependency/cryostat-agent-shaded.jar で利用可能になります。

   • Gradle の使用:

     build.gradle ファイルを更新します。

     build.gradle ファイルの例

     repositories {
     	…
     maven {
         	url "https://maven.repository.redhat.com/earlyaccess/all/"
         	credentials {
           		username "myusername"
             	password "mytoken"
         	}
     	}
     }

     エージェント JAR ファイルをアプリケーションにパッケージ化する方法は、ビルドに使用する Gradle プラグインによって異なります。たとえば、Jib プラグインを使用している場合は、次のように build.gradle ファイルを更新します。

     build.gradle ファイルの例

     plugins {
     	id 'java'
     	id 'application'
     	id 'com.google.cloud.tools.jib' version '3.3.1'
     	id 'com.ryandens.javaagent-jib' version '0.5.0'
     }
     …
     dependencies {
     	…
     	javaagent 'io.cryostat:cryostat-agent:0.3.0.redhat-00001:shaded'

2. Docker ファイルを更新します。次の例では、JAVA_OPTS 環境変数を使用して、関連する JVM 情報を渡します。

   例

   ...
   COPY target/dependency/cryostat-agent.jar /deployments/app/
   ...
   ENV JAVA_OPTS="-javaagent:/deployments/app/cryostat-agent-shaded.jar"

3. アプリケーション固有のコンテナーイメージを再構築します。

   docker build -t docker.io/myorg/myapp:latest -f src/main/docker/Dockerfile

4. Cryostat エージェントの設定に必要な JVM システムプロパティーまたは環境変数を指定するには、更新されたイメージをプッシュし、アプリケーションのデプロイメントを変更します。

   例

   apiVersion: apps/v1
   kind: Deployment
   ...
   spec:
     ...
     template:
       ...
       spec:
         containers:
           - name: sample-app
             image: docker.io/myorg/myapp:latest
             env:
               - name: CRYOSTAT_AGENT_APP_NAME
                 value: "myapp"
                 # Replace this with the Kubernetes DNS record
                 # for the Cryostat Service
               - name: CRYOSTAT_AGENT_BASEURI
                 value: "http://cryostat.mynamespace.mycluster.svc:8181"
               - name: POD_IP
                 valueFrom:
                   fieldRef:
                     fieldPath: status.podIP
               - name: CRYOSTAT_AGENT_CALLBACK
                 value: "http://$(POD_IP):9977" 

   1

   
                 # Replace "abcd1234" with a base64-encoded authentication token
               - name: CRYOSTAT_AGENT_AUTHORIZATION 

   2

   
                 value: "Bearer abcd1234"
               - name: CRYOSTAT_AGENT_API_WRITES_ENABLED 

   3

   
                 value: true
             ports:
               - containerPort: 9977
                 protocol: TCP
             resources: {}
         restartPolicy: Always
   status: {}

   • <1>: ポート番号 9977 は、Cryostat のリクエストを処理する内部 Web サーバーに対してエージェントが公開するデフォルトの HTTP ポートです。エージェントがインストールされているターゲットアプリケーションとこのポート番号が競合する場合は、番号を変更できます。
   • <2>: CRYOSTAT_AGENT_AUTHORIZATION 値は、エージェントが自身の存在をアドバタイズするために、または JFR データをプッシュするために Cryostat への API リクエストに含める認証情報を示します。また、この目的で Kubernetes Service Account を作成し、abcd1234 を、サービスアカウントに関連付けられている Base64 エンコードされた認証トークンに置き換えることもできます。
   • <3>: CRYOSTAT_AGENT_API_WRITES_ENABLED 変数はデフォルトで false に設定されます。Cryostat エージェントが Cryostat サーバーからの JFR フライト記録の開始、停止、または削除のリクエストを受け入れるようにするには、この変数を true に設定する必要があります。