加载中

使用 -javaagent 旗标手动设置

使用 -javaagent 选项是在 JVM 上设置 Java Agent 的最常用方法，它具有以下特点

  • 无需修改应用程序代码。
  • 需要更改 JVM 参数，这意味着需要重启整个 JVM。
  • 对于应用服务器，修改 JVM 参数需要更改应用服务器配置
  • Agent Artifact 是一个额外的二进制文件，需要与 JVM 或应用服务器一起管理。
  • 确保应用程序在启动前已完全插装。

开始使用 Elastic APM Java Agent 的第一步是获取 Agent jar 包的副本。

Java Agent 版本发布到 Maven central，您可以通过以下方式获取副本：

  • 从 Maven central 手动下载最新 Agent 或 以前版本。

  • 使用 curl 下载

    curl -o 'elastic-apm-agent.jar' -L 'https://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=co.elastic.apm&a=elastic-apm-agent&v=LATEST'

此外，我们还发布了一个专用的 Java Agent 构建版本，该版本附带最新的 log4j2 版本，因此至少需要 Java 8。该构建版本也可在 Maven central 上找到。

Java Agent 版本通过 docker.elastic.co 注册表作为 Docker 镜像发布。

latest 标签允许在使用镜像构建时使用最新版本。

在 Dockerfile 中添加以下语句会将 Agent jar 包复制到 /elastic-apm-agent.jar。

COPY --from=docker.elastic.co/observability/apm-agent-java:latest /usr/agent/elastic-apm-agent.jar /elastic-apm-agent.jar
注意

Agent 与常规应用程序依赖项不同。不要在应用程序中声明对 Agent 的依赖项。

启动应用程序时，添加 JVM 参数 -javaagent:/path/to/elastic-apm-agent-<version>.jar

不同的应用服务器设置 -javaagent 参数和系统属性的方式不同。

请注意，系统属性只是配置 Agent 的一种方式，但在任何情况下都必须设置 -javaagent 参数。请参阅配置，了解如何使用配置文件或环境变量配置 Agent。

启动您的应用程序（例如 Spring Boot 应用程序或其他嵌入式服务器），并添加 -javaagent JVM 参数。使用 -D 前缀通过系统属性配置 Agent。

java -javaagent:/path/to/elastic-apm-agent-<version>.jar -Delastic.apm.service_name=my-cool-service -Delastic.apm.application_packages=org.example,org.another.example -Delastic.apm.server_url=http://127.0.0.1:8200 -jar my-application.jar

创建 bin/setenv.sh 文件（如果文件已存在，则修改该文件）。确保该文件可执行，例如 chmod +x bin/setenv.sh

添加以下行

export CATALINA_OPTS="$CATALINA_OPTS -javaagent:/path/to/elastic-apm-agent-<version>.jar"
export CATALINA_OPTS="$CATALINA_OPTS -Delastic.apm.service_name=my-cool-service"
export CATALINA_OPTS="$CATALINA_OPTS -Delastic.apm.application_packages=org.example,org.another.example"
export CATALINA_OPTS="$CATALINA_OPTS -Delastic.apm.server_url=http://127.0.0.1:8200"

创建 bin\setenv.bat 文件（如果文件已存在，则修改该文件）。

set CATALINA_OPTS=%CATALINA_OPTS% -javaagent:C:/path/to/elastic-apm-agent-<version>.jar
set CATALINA_OPTS=%CATALINA_OPTS% -Delastic.apm.service_name=my-cool-service
set CATALINA_OPTS=%CATALINA_OPTS% -Delastic.apm.application_packages=org.example,org.another.example
set CATALINA_OPTS=%CATALINA_OPTS% -Delastic.apm.server_url=http://127.0.0.1:8200

选项 1：编辑 jetty.sh

export JAVA_OPTIONS="${JAVA_OPTIONS} -javaagent:/path/to/elastic-apm-agent-<version>.jar"
export JAVA_OPTIONS="${JAVA_OPTIONS} -Delastic.apm.service_name=my-cool-service"
export JAVA_OPTIONS="${JAVA_OPTIONS} -Delastic.apm.application_packages=org.example,org.another.example"
export JAVA_OPTIONS="${JAVA_OPTIONS} -Delastic.apm.server_url=http://127.0.0.1:8200"

选项 2：编辑 start.ini

--exec
-javaagent:/path/to/elastic-apm-agent-<version>.jar
-Delastic.apm.service_name=my-cool-service
-Delastic.apm.application_packages=org.example,org.another.example
-Delastic.apm.server_url=http://127.0.0.1:8200

选项 3：如果您使用的是嵌入式 Jetty，请参阅通用设置。

将 Agent 配置添加到 standalone.conf 文件的底部

Unix

export JAVA_OPTS="$JAVA_OPTS -javaagent:/path/to/elastic-apm-agent-<version>.jar"
export JAVA_OPTS="$JAVA_OPTS -Delastic.apm.service_name=my-cool-service"
export JAVA_OPTS="$JAVA_OPTS -Delastic.apm.application_packages=org.example,org.another.example"
export JAVA_OPTS="$JAVA_OPTS -Delastic.apm.server_url=http://127.0.0.1:8200"

Windows

set JAVA_OPTS=%JAVA_OPTS% -javaagent:C:/path/to/elastic-apm-agent-<version>.jar
set JAVA_OPTS=%JAVA_OPTS% -Delastic.apm.service_name=my-cool-service
set JAVA_OPTS=%JAVA_OPTS% -Delastic.apm.application_packages=org.example,org.another.example
set JAVA_OPTS=%JAVA_OPTS% -Delastic.apm.server_url=http://127.0.0.1:8200

编辑通常位于 domain/configuration 下的 domain.xml 文件，并为 -javaagent 参数添加一个 JVM 选项，以及一些用于配置的系统属性。

...
<server-group>
  <jvm>
     <jvm-options>
      ...
      <option value="-javaagent:/path/to/elastic-apm-agent-<version>.jar"/>
      ...
     </jvm-options>
  </jvm>
</server-group>
...
<system-properties>
  <property name="elastic.apm.service_name"         value="my-cool-service"/>
  <property name="elastic.apm.application_packages" value="org.example,org.another.example"/>
  <property name="elastic.apm.server_url"          value="http://127.0.0.1:8200"/>
</system-properties>
...

将以下行添加到 jvm.options 文件中。

-javaagent:/path/to/elastic-apm-agent-<version>.jar
-Delastic.apm.service_name=my-cool-service
-Delastic.apm.application_packages=org.example,org.another.example
-Delastic.apm.server_url=http://127.0.0.1:8200

更新 domain.xml 文件，添加 -javaagent 参数和系统属性。

<java-config>
  ...
  <jvm-options>-javaagent:/path/to/elastic-apm-agent-<version>.jar</jvm-options>
  <jvm-options>-Delastic.apm.service_name=my-cool-service</jvm-options>
  <jvm-options>-Delastic.apm.application_packages=org.example,org.another.example</jvm-options>
  <jvm-options>-Delastic.apm.server_url=http://127.0.0.1:8200</jvm-options>
</java-config>

编辑 startWebLogic.sh 文件，并在 setDomainEnv.sh 调用后添加以下行

export JAVA_OPTIONS="$JAVA_OPTIONS -javaagent:/path/to/elastic-apm-agent-<version>.jar"
export JAVA_OPTIONS="$JAVA_OPTIONS -Delastic.apm.service_name=my-cool-service"
export JAVA_OPTIONS="$JAVA_OPTIONS -Delastic.apm.application_packages=org.example,org.another.example"
export JAVA_OPTIONS="$JAVA_OPTIONS -Delastic.apm.server_url=http://127.0.0.1:8200"

编辑 startWebLogic.cmd 文件，并在 setDomainEnv.cmd 调用后添加以下行

set JAVA_OPTIONS=%JAVA_OPTIONS% -javaagent:C:/path/to/elastic-apm-agent-<version>.jar
set JAVA_OPTIONS=%JAVA_OPTIONS% -Delastic.apm.service_name=my-cool-service
set JAVA_OPTIONS=%JAVA_OPTIONS% -Delastic.apm.application_packages=org.example,org.another.example
set JAVA_OPTIONS=%JAVA_OPTIONS% -Delastic.apm.server_url=http://127.0.0.1:8200

自 Release v4.19 起，Elastic Java APM Agent Framework 已成为 Cloud Foundry Java Buildpack 的一部分。

用户提供的 Elastic APM 服务必须包含带有 elastic-apm 的名称或标签，以便 Elastic APM Agent Framework 能够自动配置应用程序以与该服务配合使用。

创建用户提供的服务

cf cups my-elastic-apm-service -p '{"server_url":"my-apm-server-url","secret_token":"my-apm-server-secret-token"}'

my-apm-server-url 和 my-apm-server-secret-token 分别是您的 Elasticsearch 服务器的服务密钥中的 server_url 和 secret_token。

将应用程序绑定到服务

cf bind-service my-application my-elastic-apm-service

并重新暂存应用程序，或在应用程序清单文件中使用 services 块。

有关 Cloud Foundry Elastic Java APM Agent Framework 的更多详细信息，请参阅此处。

applications:
- name: my-application
  memory: 1G
  path: ./target/my-application.jar
  services:
    - my-elastic-apm-service
© . All rights reserved.