appdynamics/java-agent

AppDynamics Java Agent Docker镜像文档

1. 镜像概述和主要用途

1.1 主要用途

本Docker镜像作为AppDynamics Java Agent二进制文件的分发媒介，用于将Agent文件复制到应用程序容器中，以实现对Java应用程序的性能监控集成。

1.2 重要说明

注意：本Docker镜像专门设计用于交付AppDynamics Java Agent二进制文件。强烈建议客户不要将此镜像用作其应用程序容器的基础镜像。

2. 核心功能和特性

• Agent文件分发：提供完整的AppDynamics Java Agent二进制文件（包含javaagent.jar及相关依赖文件）
• 轻量级集成：通过文件复制方式集成，不引入额外运行时依赖
• 跨环境兼容：支持Kubernetes、OpenShift等容器编排平台及标准Docker环境
• 构建优化：适配Docker多阶段构建流程，避免增加最终应用镜像体积

3. 使用场景和适用范围

• 容器编排环境：适用于Kubernetes、OpenShift等平台，通过Init容器机制前置部署Agent文件
• Docker构建流程：适用于采用多阶段Docker构建的Java应用项目
• 容器化Java应用：所有基于Docker容器部署的Java应用程序，需集成AppDynamics监控能力的场景

4. 详细的使用方法和配置说明

4.1 使用Init容器（Kubernetes/OpenShift环境）

通过Init容器在主应用容器启动前完成Agent文件复制，利用共享卷实现文件共享。

配置示例（Kubernetes YAML片段）：

yaml
---
initContainers:
  - name: appd-agent
    image: appdynamics/java-agent:latest
    command: ["cp", "-r", "/opt/appdynamics/.", "/opt/appdynamics"]
    volumeMounts:
      - name: appd-agent-repo
        mountPath: /opt/appdynamics
containers:
  - name: my-java-app
    image: my-java-app-image:latest
    volumeMounts:
      - name: appd-agent-repo
        mountPath: /opt/appdynamics
    env:
      - name: JAVA_TOOL_OPTIONS
        value: -javaagent:/opt/appdynamics/javaagent.jar
volumes:
  - name: appd-agent-repo
    emptyDir: {}

配置说明：

• Init容器配置：使用appdynamics/java-agent:latest镜像，执行cp命令将/opt/appdynamics目录下所有文件复制到共享卷
• 共享卷配置：定义appd-agent-repo空目录卷，实现Init容器与主应用容器间的文件共享
• 应用容器配置：挂载共享卷至/opt/appdynamics，通过JAVA_TOOL_OPTIONS环境变量指定Agent路径

4.2 多阶段Docker构建集成

通过多阶段构建从Agent镜像复制文件，集成到应用镜像中。

配置示例（应用Dockerfile）：

dockerfile
# 阶段1: 获取Agent文件
FROM appdynamics/java-agent:latest AS appd-agent

# 阶段2: 构建应用镜像
FROM openjdk:17-jdk-slim  # 替换为实际应用基础镜像

# 复制Agent文件
COPY --from=appd-agent /opt/appdynamics /opt/appdynamics

# 配置Agent启动参数
ENV JAVA_TOOL_OPTIONS="-javaagent:/opt/appdynamics/javaagent.jar"

# 应用部署配置
WORKDIR /app
COPY target/my-java-app.jar /app/my-java-app.jar
CMD ["java", "-jar", "my-java-app.jar"]

配置说明：

• 多阶段构建：第一阶段使用Agent镜像作为构建源，第二阶段基于应用基础镜像构建最终镜像
• 文件复制：通过COPY --from=appd-agent将Agent文件从第一阶段复制到/opt/appdynamics目录
• Agent启用：设置JAVA_TOOL_OPTIONS环境变量，指定Java Agent路径

5. 配置参数说明

5.1 环境变量

5.2 卷配置

6. 注意事项

1. 镜像仅用于Agent文件分发，禁止作为应用容器基础镜像
2. 建议使用具体版本标签（如appdynamics/java-agent:21.10.0）替代latest，确保版本稳定性
3. 确保应用容器对/opt/appdynamics目录有读取权限
4. JAVA_TOOL_OPTIONS中指定的Agent路径必须与实际挂载路径一致