链路监控-skywalking

发表于 2023-12-19 分类于监控， apm 阅读次数：本文字数： 7.1k 阅读时长 ≈ 6 分钟

介绍

部署

Java agent 探针

Agent的可配置属性列表

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

属性名	描述	默认值
`agent.namespace`	命名空间，用于隔离跨进程传播的header。如果进行了配置，header将为`HeaderName:Namespace`.	未设置
`agent.service_name`	在SkyWalking UI中展示的服务名。5.x版本对应Application，6.x版本对应Service。建议：为每个服务设置个唯一的名字，服务的多个服务实例为同样的服务名	`Your_ApplicationName`
`agent.sample_n_per_3_secs`	负数或0表示不采样，默认不采样。SAMPLE_N_PER_3_SECS表示每3秒采样N条。	未设置
`agent.authentication`	鉴权是否开启取决于后端的配置，可查看application.yml的详细描述。对于大多数的场景，需要后端对鉴权进行扩展。目前仅实现了基本的鉴权功能。	未设置
`agent.span_limit_per_segment`	单个segment中的span的最大个数。通过这个配置项，Skywalking可评估应用程序内存使用量。	未设置
`agent.ignore_suffix`	如果这个集合中包含了第一个span的操作名，这个segment将会被忽略掉。	未设置
`agent.is_open_debugging_class`	如果为true，skywalking会将所有经Instrument转换过的类文件保存到`/debugging`文件夹下。Skywalking团队会要求你提供这些类文件以解决兼容性问题。	未设置
`agent.cause_exception_depth`	在记录异常信息的时候, 探针需要记录的堆栈深度.	5
`agent.force_reconnection_period`	grpc的强制重连周期，基于grpc_channel_check_interval.	`1`
`agent.operation_name_threshold`	设置操作名不建议超过最大长度(190).	`150`
`agent.keep_tracing`	如果该值为 `true`，即使后台不可用，也要保持跟踪.	`false`
`osinfo.ipv4_list_size`	限制ipv4列表的长度.	`10`
`collector.grpc_channel_check_interval	检查grpc的channel状态的时间间隔。	`30`
`collector.backend_service`	接收skywalking trace数据的后端地址	`127.0.0.1:11800`
`collector.heartbeat_period`	探针心跳报告时间. 单位秒.	`30`
`collector.grpc_upstream_timeout`	grpc客户端向上游发送数据时超时多长时间. 单位秒.	`30` 秒
`collector.get_profile_task_interval`	嗅探器获取配置文件任务列表间隔.	`20`
`logging.level`	日志级别。默认为debug。	`DEBUG`
`logging.file_name`	日志文件名	`skywalking-api.log`
`logging.output`	日志输出. 默认是文件. 使用控制台意味着输出到标准输出.	`FILE`
`logging.dir`	日志目录。默认为空串，表示使用”system.out”输出日志。	`""`
`logging.pattern`	日志格式. 所有的转换说明符: * `%level` means log level. * `%timestamp` 表示现在的时间格式 `yyyy-MM-dd HH:mm:ss:SSS`. * `%thread` 表示当前线程的名称. * `%msg` 表示用户记录的某些消息. * `%class` 表示TargetClass的SimpleName. * `%throwable` 表示用户抛出的异常. * `%agent_name` 表示 `agent.service_name`	`%level %timestamp %thread %class : %msg %throwable`
`logging.max_file_size`	日志文件的最大大小。当日志文件大小超过这个数，归档当前的日志文件，将日志写入到新文件。	`300 * 1024 * 1024`
`logging.max_history_files`	The max history log files. When rollover happened, if log files exceed this number,then the oldest file will be delete. Negative or zero means off, by default.	`-1`
`jvm.buffer_size`	收集JVM信息的buffer的大小。	`60 * 10`
`buffer.channel_size`	buffer的channel大小。	`5`
`buffer.buffer_size`	buffer的大小	`300`
`profile.active`	如果为`true`，SkyWalking代理将在用户创建新的配置文件任务时启用配置文件. 否则禁用概要.	`true`
`profile.max_parallel`	并行监控段计数	`5`
`profile.duration`	监控段最大时间(分钟)，如果当前监控段时间超出限制，则停止.	`10`
`profile.dump_max_stack_depth`	最大线程转储的堆栈深度	`500`
`profile.snapshot_transport_buffer_size`	快照传输到后端缓冲区的大小	`50`
`plugin.mongodb.trace_param`	如果为true，记录所有访问MongoDB的参数信息。默认为false，表示仅记录操作名，不记录参数信息。	`false`
`plugin.elasticsearch.trace_dsl`	如果为true，记录所有访问ElasticSearch的DSL信息。默认为false。	`false`
`plugin.springmvc.use_qualified_name_as_endpoint_name`	如果为true，endpoint的name为方法的全限定名，而不是请求的URL。默认为false。	`false`
`plugin.toolit.use_qualified_name_as_operation_name`	如果为true，operation的name为方法的全限定名，而不是给定的operation name。默认为false。	`false`
`plugin.mysql.trace_sql_parameters`	如果设置为 true, SQL 查询 (典型的是 `java.sql.PreparedStatement`) 的参数也会被采集.	`false`
`plugin.mysql.sql_parameters_max_length`	如果设置为正整数, 收集的 SQL 参数 `db.sql.parameters` 会被截断到这个长度, 否则会被完整保存, 这可能会导致性能问题.	`512`
`plugin.solrj.trace_statement`	如果为 true, 追踪 Solr 查询请求中的所有查询参数(包括 deleteByIds 和 deleteByQuery) 默认为 false.	`false`
`plugin.solrj.trace_ops_params`	如果为 true, 追踪 Solr 查询中所有操作参数, 默认为 false.	`false`
`plugin.peer_max_length`	Peer 描述最大限制.	`200`
`plugin.mongodb.filter_length_limit`	如果设置为正数, `WriteRequest.params` 将被截短到这个长度, 否则它将被完全保存，这可能会导致性能问题.	`256`
`plugin.postgresql.trace_sql_parameters`	如果设置为true，将收集sql的参数(通常是 `java.sql.PreparedStatement`).	`false`
`plugin.postgresql.sql_parameters_max_length`	如果设置为正数, `db.sql.parameters` 将被截断到这个长度，否则它将被完全保存，这可能会导致性能问题.	`512`
`plugin.mariadb.trace_sql_parameters`	如果设置为true，将收集sql的参数(通常是 `java.sql.PreparedStatement`).	`false`
`plugin.mariadb.sql_parameters_max_length`	如果设置为正数，`db.sql` 将被截断到这个长度，否则它将被完全保存，这可能会导致性能问题.	`512`
`plugin.light4j.trace_handler_chain`	如果为`true`，请跟踪属于请求的Light4J处理程序链的所有中间件/业务处理程序.	false
`plugin.opgroup.*`	支持在不同插件中自定义组规则的操作名. 请阅读 Group rule supported plugins	Not set
`plugin.springtransaction.simplify_transaction_definition_name`	如果为`true`，事务定义名称将被简化.	false
`plugin.jdkthreading.threading_class_prefixes`	线程类 (`java.lang.Runnable` and `java.util.concurrent.Callable`) 及其子类(包括任何名称匹配 `THREADING_CLASS_PREFIXES` (以 `，` 分隔)的匿名内部类) 将被检测, 确保只指定短小的前缀，就像您预期要测试的一样, (`java.` 和 `javax.` 会因安全问题而被忽略)	Not set
`plugin.tomcat.collect_http_params`	这个配置项控制Tomcat插件是否应该收集请求的参数. 同样，在概要追踪中隐式激活.	`false`
`plugin.springmvc.collect_http_params`	这个配置项控制SpringMVC插件是否应该收集请求的参数, 当您的Spring应用程序基于Tomcat时, 只需要设置 `plugin.tomcat.collect_http_params` 或 `plugin.springmvc.collect_http_params` 之一. 同样，在概要追踪中隐式激活.	`false`
`plugin.http.http_params_length_threshold`	当启用 `COLLECT_HTTP_PARAMS`时，要保留多少字符并将其发送到OAP后端，请使用负值来保留和发送完整的参数. 添加这个配置项是为了提高性能.	`1024`
`correlation.element_max_number`	关联上下文的最大元素数.	`3`
`correlation.value_max_length`	关联上下文元素的最大值长度.	`128`

可选的插件

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

Bootstrap 类插件

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

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

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

设置覆盖

默认情况下，SkyWalking提供agent.config文件给代理。

设置覆盖意味着最终用户可以通过使用系统属性或代理选项来覆盖这些配置文件中的设置。

系统属性

在配置文件中使用 skywalking. + key 作为系统属性键，以覆盖该值。

为什么需要这个前缀？

代理系统属性和环境与目标应用程序共享，这个前缀可以避免变量冲突。

示例

通过以下方式覆盖 agent.application_code。

bashCopy code
-Dskywalking.agent.application_code=31200

代理选项

在JVM参数中在代理路径后添加属性。

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

示例

通过以下方式覆盖 agent.application_code 和 logging.level。

bashCopy code
-javaagent:/path/to/skywalking-agent.jar=agent.application_code=31200,logging.level=debug

特殊字符

如果选项或值中有分隔符(,或=)，应该用引号括起来。

bashCopy code
-javaagent:/path/to/skywalking-agent.jar=agent.ignore_suffix='.jpg,.jpeg'

系统环境变量

示例

通过以下方式覆盖 agent.application_code 和 logging.level。

bashCopy code
# UI中的服务名称
agent.service_name=${SW_AGENT_NAME:Your_ApplicationName}

# 日志级别
logging.level=${SW_LOGGING_LEVEL:INFO}

如果操作系统中存在名为 SW_AGENT_NAME 的环境变量且其值为 skywalking-agent-demo，则此处 agent.service_name 的值将被覆盖为 skywalking-agent-demo，否则将设置为 Your_ApplicationName。

另外，还支持占位符嵌套，如${SW_AGENT_NAME:${ANOTHER_AGENT_NAME:Your_ApplicationName}}。在这种情况下，如果 SW_AGENT_NAME 环境变量不存在，但 ANOTHER_AGENT_NAME 环境变量存在且其值为 skywalking-agent-demo，则此处 agent.service_name 的值将被覆盖为 skywalking-agent-demo，否则将设置为 Your_ApplicationName。

覆盖优先级

代理选项 > 系统属性(-D) > 系统环境变量 > 配置文件

常用配置

采样率配置

采样率配置：agent.sample_n_per_3_secs=${SW_AGENT_SAMPLE:-1}

配置文件配置

配置文件路径：agent/config/agent.config

修改采样率。**agent.sample_n_per_3_secs  表示设置每3秒可收集的链路数据（TraceSegment）的数量。负或零表示全部采样，默认全部采样。
示例：
假设您需要在3秒内采集1500个 TraceSegment ，可以设置为：
agent.sample_n_per_3_secs=${SW_AGENT_SAMPLE:1500}

通过环境变量配置

新增环境变量 export SW_AGENT_SAMPLE=15000

Agent日志配置

agent/config/agent.config
- logging.level  日志级别。默认为debug。
- logging.max_file_size 日志文件的最大大小，默认300M
- logging.max_history_files  最大历史日志文件，默认无限制。

忽略指定端点

不是所有的接口都需要采集，所以需要排除部分接口，比如健康检查接口，Eureka心跳信息等.这样可以节省不必要的数据采集和存储

将 optional-plugins/apm-trace-ignore-plugin-8.13.0.jar 拷贝到plugins/

cp optional-plugins/apm-trace-ignore-plugin-8.13.0.jar plugins/

通过系统属性配置

-Dskywalking.trace.ignore_path=/actuator/health

通过配置文件

在config目录下创建apm-trace-ignore-plugin.config文件并添加如下配置激活插件：

trace.ignore_path=/your/path/1/**,/your/path/2/** ➊

➊ 中的路径配置规则支持Ant Path匹配风格，比如： /path/*, /path/**, /path/?。匹配的Path路径将不会被记录。