第 3 章 配置 Java 应用程序

流程

1. 安装 Cryostat 代理。根据您的应用程序构建选择以下选项之一：

   • 使用 Maven：

     使用 Cryostat 代理 JAR 文件信息更新应用程序 pom.xml 文件。

     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.4.X.redhat-xxxxx</version>
                       <classifier>shaded</classifier>
                     </artifactItem>
                   </artifactItems>
                   <stripVersion>true</stripVersion>
                 </configuration>
               </execution>
             </executions>
           </plugin>
         </plugins>
         ...
       </build>
       ...
     </project>

     注意

     在前面的示例中，将 0.4.X.redhat-xxxxx 替换为 Cryostat 代理的最新版本和构建号。有关 Cryostat 代理的最新版本和构建号的详情，请参考 Red Hat Maven 存储库。

     下次构建应用程序时，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.4.X.redhat-xxxxx:shaded'

     注意

     在前面的示例中，将 0.4.X.redhat-xxxxx 替换为 Cryostat 代理的最新版本和构建号。有关 Cryostat 代理的最新版本和构建号的详情，请参考 Red Hat Maven 存储库。

2. 更新 Docker 文件。以下示例使用 JAVA_OPTS 环境变量传递相关的 JVM 信息。

   Example

   ...
   COPY target/dependency/cryostat-agent-shaded.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 系统属性或环境变量，请推送更新的镜像，然后修改应用程序部署。

   Example

   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:4180"
               - name: POD_IP
                 valueFrom:
                   fieldRef:
                     fieldPath: status.podIP
               - name: CRYOSTAT_AGENT_CALLBACK
                 value: "http://$(POD_IP):9977" 

   1

   
                 # Replace "abcd1234" with a plain-text 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 值显示代理在 API 请求中包含的凭证，以公告其自身存在或推送 JFR 数据。您还可以为此目的创建一个 Kubernetes 服务帐户，并将 abcd1234 替换为与服务帐户关联的纯文本身份验证令牌。
   • <3>：默认情况下 CRYOSTAT_AGENT_API_WRITES_ENABLED 变量设为 false。如果您希望 Cryostat 代理接受来自 Cryostat 服务器的请求以启动、停止或删除 JFR flight 记录，您必须将此变量设置为 true。