# 安装Java agent

1. 7.x版本中代理支持 JDK 8 - 14， 6.x版本支持JDK 1.6 - JDK 12 NOTICE¹
2. 在SkyWalking发行包中找到agent文件夹
3. 配置config/agent.config中的agent.service_name。可以是任意的英文字符串。
4. 配置config/agent.config中的collector.backend_service。默认指向127.0.0.1:11800，表示仅作用于本地后端。
5. JVM参数中添加-javaagent:/path/to/skywalking-package/agent/skywalking-agent.jar，并且确保这个参数在-jar参数之前。

agent发行包包含在Apache官方发行版中。最新的agent包结构如下。

+-- agent
    +-- activations
         apm-toolkit-log4j-1.x-activation.jar
         apm-toolkit-log4j-2.x-activation.jar
         apm-toolkit-logback-1.x-activation.jar
         ...
    +-- config
         agent.config  
    +-- plugins
         apm-dubbo-plugin.jar
         apm-feign-default-http-9.x.jar
         apm-httpClient-4.x-plugin.jar
         .....
    +-- optional-plugins
         apm-gson-2.x-plugin.jar
         .....
    +-- bootstrap-plugins
         jdk-http-plugin.jar
         .....
    +-- logs
    skywalking-agent.jar

• 启动你的应用。

# 支持的中间件、框架和库

SkyWalking agent已经对多种中间件、框架和库进行了支持。 通过支持列表可以了解对哪些进行了支持以及支持了哪些版本。 如果插件被标注为可选²，请到可选的插件 章节去学习如何激活插件。

# 高级特性

• 所有的插件都在/plugins文件夹下。当某个插件的jar包在此文件夹下，表示此插件已被激活；从这个文件夹下移除后，表示插件不可用.
• 默认的日志输出文件夹为/logs。

# 关于安装java agent的FAQ

• Linux Tomcat 7, Tomcat 8
  修改tomcat/bin/catalina.sh的第一行。

CATALINA_OPTS="$CATALINA_OPTS -javaagent:/path/to/skywalking-agent/skywalking-agent.jar"; export CATALINA_OPTS

• Windows Tomcat 7, Tomcat 8
  修改tomcat/bin/catalina.bat的第一行。

set "CATALINA_OPTS=-javaagent:/path/to/skywalking-agent/skywalking-agent.jar"

• JAR包 使用命令行启动应用时，添加-javaagent参数。比如：

java -javaagent:/path/to/skywalking-agent/skywalking-agent.jar -jar yourApp.jar

• Jetty
  修改 jetty.sh, 在启动应用程序的命令行中添加 -javaagent 参数. 比如:

export JAVA_OPTIONS="${JAVA_OPTIONS} -javaagent:/path/to/skywalking-agent/skywalking-agent.jar"

# Agent的可配置属性列表

这里是agent/config/agent.config中支持的属性列表。

# 可选的插件

Java agent的所有插件都是可插拔的。在agent或第三方仓库的optional-plugins 文件夹下提供了可选的插件。 想要使用可选插件，你需要将对应插件移动到/plugins文件夹下。

目前，我们提供了如下的可选插件。

• 追踪Spring注解的bean
• 追踪Oracle和Resin
• 通过指定endpoint模式来过滤trace
• Gson序列化库
• Lettuce 5.x(JRE1.8+)
• Zookeeper 3.4.x。 将此插件定为可选插件的原因在于：会生成大量的业务不相关的trace，对agent和后端产生了额外的负载。并且，这些trace数据可能仅仅是心跳数据。
• 自定义增强 基于描述文件对方法进行追踪，而不是通过写插件或修改源代码。
• Spring Cloud Gateway 2.1.x 插件. 只有当你在 Spring Gateway 端安装了插件时才开启此插件.

# Bootstrap 类插件

由于意外风险，所有 Bootstrap 插件都是可选的。Bootstrap 插件在 bootstrap-plugins 文件夹中提供. 若使用这些插件，您需要将目标插件 jar 文件放入 /plugins 中.

现在，我们有以下已知的 Bootstrap 插件.

• JDK HttpURLConnection 插件. Agent 兼容 JDK 1.6+
• JDK Callable and Runnable 插件. Agent 兼容 1.6+

# 高级特性

• 可通过设置系统属性覆盖配置文件中的配置。请见配置覆盖.
• 可使用gRPC TLS将后端连接起来。请见open TLS
• 通过不同的SkyWalking服务实现对大集群的监控。使用命名空间隔离上下文传播。
• 如果后端开启了token鉴权，客户端可设置token。
• 应用工具包。应用工具包，是Skywalking提供的一些库的集合。通过这些库，可以将你的应用同Skywalking agent联系起来。
  • 如果你想使用OpenTracing的Java API，可以试试兼容OpenTracing的Skywalking tracer. 更多细节可以查看http://opentracing.io
  • 如果你想在你的日志中打印trace上下文（比如traceId），选择你使用的日志框架log4j, log4j2, logback
  • 如果你想使用注解或者SkyWalking本地API读取trace上下文，试一下SkyWalking manual APIs吧。
  • 如果你想通过手动的方式实现trace跨线程传递，可以使用跨线程传递API。
• 如果你想指定你的agent.config文件的路径，请见通过系统属性设置配置文件路径

# 插件开发指南

SkyWalking java agent支持插件的开发以扩展支持列表。如果你想开发java agent插件，请阅读插件开发指南。

# 测试

如果你对插件的兼容性测试或agent的性能感兴趣，可以阅读下面的测试报告。

• Plugin Test
• Java Agent Performance Test

# 注意

¹ 由于自2018年以来gRPC不支持JDK 1.6, SkyWalking 在所有 7.x 版本都放弃支持 JDK 6/7. 但是，gRPC向前向后兼容(至少目前如此), 所有 SkyWalking 6.x agents 均可以与 7.x(包括agent 和 后台)协作.