前言
当使用分布式追踪系统时,有时需要排除某些端点或路径,以减轻追踪系统的负载或减少不必要的数据收集。为了满足这种需求,SkyWalking 提供了一个可选的插件,即 apm-trace-ignore-plugin
,它允许自定义需要跳过的路径模式。
功能概述
该插件的主要功能是过滤预期被跟踪系统忽略的端点。可以设置多个 URL 路径模式,匹配这些模式的端点将不会被跟踪。即使启用了跟踪忽略插件,采样机制仍然有效。
匹配规则
当前的匹配规则遵循 Ant Path 匹配风格:
*
表示匹配零个或多个字符。**
表示匹配零个或多个目录。?
表示匹配一个字符。
例如,/path/*
、/path/**
、/path/?
分别表示不同的路径匹配模式。
配置方法
可以通过以下两种方法配置忽略模式,系统环境设置具有更高的优先级:
-
通过系统环境变量设置:
- 将
skywalking.trace.ignore_path
添加到系统环境变量中。 - 变量的值为需要忽略的路径,多个路径之间用逗号分隔。
- 例如:
skywalking.trace.ignore_path=/your/path/1/**,/your/path/2/**
- 将
-
通过配置文件:
- 创建名为
apm-trace-ignore-plugin.config
的文件,放置在/agent/config/
目录下。 - 在配置文件中添加需要忽略的路径规则。
- 例如,在配置文件中添加如下规则:
trace.ignore_path=/your/path/1/**,/your/path/2/**
- 创建名为
生效方式
要使配置生效,需将 apm-trace-ignore-plugin-x.jar
复制到 agent 的 plugins
目录中,并重启 agent。此后,配置的忽略路径规则将生效,指定的路径将不会被跟踪。
总结
通过使用 apm-trace-ignore-plugin
插件,可以更精细地控制哪些路径需要被追踪,从而实现更高效的追踪数据收集。