Skywalking：Java Agent配置详解

骑猪看日落 2021-06-24 13:58 942阅读 0赞

Java Agent支持的配置属性

> TIPS  
> 本表格基于Skywalking 6.6.0，官方文档详见：https://github.com/apache/skywalking/blob/v6.6.0/docs/en/setup/service-agent/java-agent/README.md ，其他版本配置项不完全相同，请自行将链接中的 v6.6.0 修改成你所使用的版本。

<table> 
 <thead> 
  <tr> 
   <th>属性名</th> 
   <th>描述</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>agent.namespace</td> 
   <td>命名空间，用于隔离跨进程传播的header。如果进行了配置，header将为HeaderName:Namespace.</td> 
   <td>未设置</td> 
  </tr> 
  <tr> 
   <td>agent.service_name</td> 
   <td>在SkyWalking UI中展示的服务名。5.x版本对应Application，6.x版本对应Service。 建议：为每个服务设置个唯一的名字，服务的多个服务实例为同样的服务名</td> 
   <td>Your_ApplicationName</td> 
  </tr> 
  <tr> 
   <td>agent.sample_n_per_3_secs</td> 
   <td>负数或0表示不采样，默认不采样。SAMPLE_N_PER_3_SECS表示每3秒采样N条。</td> 
   <td>未设置</td> 
  </tr> 
  <tr> 
   <td>agent.authentication</td> 
   <td>鉴权是否开启取决于后端的配置，可查看application.yml的详细描述。对于大多数的场景，需要后端对鉴权进行扩展。目前仅实现了基本的鉴权功能。</td> 
   <td>未设置</td> 
  </tr> 
  <tr> 
   <td>agent.span_limit_per_segment</td> 
   <td>单个segment中的span的最大个数。通过这个配置项，Skywalking可评估应用程序内存使用量。</td> 
   <td>300</td> 
  </tr> 
  <tr> 
   <td>agent.ignore_suffix</td> 
   <td>如果这个集合中包含了第一个span的操作名，这个segment将会被忽略掉。</td> 
   <td>未设置</td> 
  </tr> 
  <tr> 
   <td>agent.is_open_debugging_class</td> 
   <td>如果为true，skywalking会将所有经Instrument转换过的类文件保存到/debugging文件夹下。Skywalking团队会要求你提供这些类文件以解决兼容性问题。</td> 
   <td>未设置</td> 
  </tr> 
  <tr> 
   <td>agent.active_v2_header</td> 
   <td>是否默认使用v2版本的header。</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>agent.instance_uuid</td> 
   <td>实例id。skywalking会将实例id相同的看做一个实例。如果为空，skywalking agent会生成一个32位的uuid。</td> 
   <td>“”</td> 
  </tr> 
  <tr> 
   <td>agent.instance_properties[key]=value</td> 
   <td>添加服务实例的定制属性。</td> 
   <td>未设置</td> 
  </tr> 
  <tr> 
   <td>agent.cause_exception_depth</td> 
   <td>agent记录的异常时，代理进入的深度</td> 
   <td>5</td> 
  </tr> 
  <tr> 
   <td>agent.active_v1_header</td> 
   <td>是否默认使用v1版本的header。</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>agent.cool_down_threshold</td> 
   <td>收到reset命令后，代理应等待多久（以分钟为单位）才能重新注册到OAP服务器。</td> 
   <td>10</td> 
  </tr> 
  <tr> 
   <td>agent.force_reconnection_period</td> 
   <td>根据grpc_channel_check_interval强制重新连接grpc。</td> 
   <td>1</td> 
  </tr> 
  <tr> 
   <td>agent.operation_name_threshold</td> 
   <td>operationName最大长度，不建议将此值设置为&gt; 500。</td> 
   <td>500</td> 
  </tr> 
  <tr> 
   <td>collector.grpc_channel_check_interval</td> 
   <td>检查grpc的channel状态的时间间隔。</td> 
   <td>30</td> 
  </tr> 
  <tr> 
   <td>collector.app_and_service_register_check_interval</td> 
   <td>检查应用和服务的注册状态的时间间隔。</td> 
   <td>3</td> 
  </tr> 
  <tr> 
   <td>collector.backend_service</td> 
   <td>接收skywalking trace数据的后端地址</td> 
   <td>127.0.0.1:11800</td> 
  </tr> 
  <tr> 
   <td>collector.grpc_upstream_timeout</td> 
   <td>grpc客户端向上游发送数据时的超时时间，单位秒。</td> 
   <td>30 秒</td> 
  </tr> 
  <tr> 
   <td>logging.level</td> 
   <td>日志级别。默认为debug。</td> 
   <td>DEBUG</td> 
  </tr> 
  <tr> 
   <td>logging.file_name</td> 
   <td>日志文件名</td> 
   <td>skywalking-api.log</td> 
  </tr> 
  <tr> 
   <td>logging.output</td> 
   <td>日志输出，默认FILE。CONSOLE表示输出到stdout。</td> 
   <td>FILE</td> 
  </tr> 
  <tr> 
   <td>logging.dir</td> 
   <td>日志目录。默认为空串，表示使用"system.out"输出日志。</td> 
   <td>“”</td> 
  </tr> 
  <tr> 
   <td>logging.pattern</td> 
   <td>日志记录格式。所有转换说明符：<br> *&nbsp;<strong>%level</strong>&nbsp;表示日志级别。<br> *&nbsp;<strong>%timestamp</strong>&nbsp;表示现在的时间，格式yyyy-MM-dd HH:mm:ss:SSS。<br> *&nbsp;<strong>%thread</strong>&nbsp;表示当前线程的名称。<br> *&nbsp;<strong>%msg</strong>&nbsp;表示消息。<br> *&nbsp;<strong>%class</strong>&nbsp;表示TargetClass的SimpleName。<br> *&nbsp;<strong>%throwable</strong>&nbsp;表示异常。<br> *&nbsp;<strong>%agent_name</strong>&nbsp;表示agent.service_name</td> 
   <td>%level %timestamp %thread %class : %msg %throwable</td> 
  </tr> 
  <tr> 
   <td>logging.max_file_size</td> 
   <td>日志文件的最大大小。当日志文件大小超过这个数，归档当前的日志文件，将日志写入到新文件。</td> 
   <td>300 * 1024 * 1024</td> 
  </tr> 
  <tr> 
   <td>logging.max_history_files</td> 
   <td>最大历史记录日志文件。发生翻转时，如果日志文件超过此值，则最早的文件将被删除。默认情况下，负数或零表示关闭。</td> 
   <td>-1</td> 
  </tr> 
  <tr> 
   <td>jvm.buffer_size</td> 
   <td>收集JVM信息的buffer的大小。</td> 
   <td>60 * 10</td> 
  </tr> 
  <tr> 
   <td>buffer.channel_size</td> 
   <td>buffer的channel大小。</td> 
   <td>5</td> 
  </tr> 
  <tr> 
   <td>buffer.buffer_size</td> 
   <td>buffer的大小</td> 
   <td>300</td> 
  </tr> 
  <tr> 
   <td>dictionary.service_code_buffer_size</td> 
   <td>The buffer size of application codes and peer</td> 
   <td>10 * 10000</td> 
  </tr> 
  <tr> 
   <td>dictionary.endpoint_name_buffer_size</td> 
   <td>The buffer size of endpoint names and peer</td> 
   <td>1000 * 10000</td> 
  </tr> 
  <tr> 
   <td>plugin.peer_max_length</td> 
   <td>Peer最大描述限制</td> 
   <td>200</td> 
  </tr> 
  <tr> 
   <td>plugin.mongodb.trace_param</td> 
   <td>如果为true，记录所有访问MongoDB的参数信息。默认为false，表示仅记录操作名，不记录参数信息。</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>plugin.mongodb.filter_length_limit</td> 
   <td>如果设为正数，WriteRequest.params 将被截断为该长度，否则将被完全保存，这可能会导致性能问题。</td> 
   <td>256</td> 
  </tr> 
  <tr> 
   <td>plugin.elasticsearch.trace_dsl</td> 
   <td>如果为true，记录所有访问ElasticSearch的DSL信息。默认为false。</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>plugin.springmvc.use_qualified_name_as_endpoint_name</td> 
   <td>如果为true，endpoint的name为方法的全限定名，而不是请求的URL。默认为false。</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>plugin.toolit.use_qualified_name_as_operation_name</td> 
   <td>如果为true，operation的name为方法的全限定名，而不是给定的operation name。默认为false。</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>plugin.mysql.trace_sql_parameters</td> 
   <td>如果设置为true，则将收集sql的参数（通常为java.sql.PreparedStatement）。</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>plugin.mysql.sql_</td> 
   <td>parameters_max_length 如果设置为正数，db.sql.parameters 将被截断为该长度，否则将被完全保存，这可能会导致性能问题。</td> 
   <td>512</td> 
  </tr> 
  <tr> 
   <td>plugin.postgresql.trace_sql_parameters</td> 
   <td>如果设置为true，则将收集sql的参数（通常为java.sql.PreparedStatement）。</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>plugin.postgresql.sql_parameters_max_length</td> 
   <td>如果设置为正数，db.sql.parameters 将被截断为该长度，否则将被完全保存，这可能会导致性能问题。</td> 
   <td>512</td> 
  </tr> 
  <tr> 
   <td>plugin.solrj.trace_statement</td> 
   <td>如果为true，则在Solr查询请求中跟踪所有查询参数（包括deleteByIds和deleteByQuery）</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>plugin.solrj.trace_ops_params</td> 
   <td>如果为true，则跟踪Solr请求中的所有操作参数</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>plugin.light4j.trace_handler_chain</td> 
   <td>如果为true，请跟踪Light4J的请求的所有中间件/业务handler。</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>plugin.opgroup.*</td> 
   <td>支持操作名称自定义不同插件中的组的规则。详见 支持组规则的插件</td> 
   <td>未设置</td> 
  </tr> 
  <tr> 
   <td>plugin.springtransaction.simplify_transaction_definition_name</td> 
   <td>设为true，则简化事务定义名称。</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>plugin.jdkthreading.threading_class_prefixes</td> 
   <td>将对名称与任意一个 THREADING_CLASS_PREFIXES (多个使用 , 分隔)匹配的线程化类（ java.lang.Runnable 和 java.util.concurrent.Callable ）及其子类进行 Instrument，请确保仅将窄前缀指定为您希望Instrument的前缀（安全考虑， java. 和 javax. 将被忽略）</td> 
   <td>未设置</td> 
  </tr> 
 </tbody> 
</table>

Java Agent配置方式

agent配置有多种姿势，上面修改 `agent.config` 文件中的值，只是其中一种。下面专门探讨agent支持的配置方式。

系统属性(-D)

使用 `-Dskywalking.` + `agent.config`配置文件中的key 即可。例如：

`agent.config` 文件中有一个属性名为 `agent.service_name` ，那么如果使用系统属性的方式，则可以写成

java -javaagent:/opt/agent/skywalking-agent.jar -Dskywalking.agent.service_name=你想设置的值 -jar somr-spring-boot.jar

代理选项

在JVM参数中的代理路径之后添加属性即可。格式：

-javaagent:/path/to/skywalking-agent.jar=[option1]=[value1],[option2]=[value2]

例如：

java -javaagent:/opt/agent/skywalking-agent.jar=agent.service_name=你想设置的值 -jar somr-spring-boot.jar

系统环境变量