【SkyWalking】启用apm-trace-ignore-plugin追踪忽略插件

背景

使用Agent采集追踪数据的时候，想排除某些路径，比如健康检查等，这样可以减少上报的数据，也可以去除一些不必要的干扰数据。

加载插件

在agent/optional-plugins目录中有个apm-trace-ignore-plugin-${version}.jar插件，用于处理忽略操作，加载jar有两种方案

• 将apm-trace-ignore-plugin-${version}.jar拷贝到agent/plugins目录下进行加载
• 修改agent/config/agent.config配置文件中的plugin.mount参数，将optional-plugins包添加到加载插件库中，这里面有多个插件会一起加载。

配置忽略端点

方式一：配置文件

在agent/config下创建apm-trace-ignore-plugin.config文件，内容如下

#  忽略路径数据上传
#  路径匹配规则
#  /path/?   单个字符
#  /path/*   多个字符
#  /path/**  多个字符和多级路径
#  多个规则使用逗号“,”分割
trace.ignore_path=${SW_AGENT_TRACE_IGNORE_PATH:GET:/health}

• 这里有个特别需要注意的点，经过agent-9.2.0版本反复测试
• 如果配置/health，一直没有生效
• 最后通过源码断点调试，发现apm-trace-ignore-plugin这个插件收到的请求是GET:/health, 难怪一直不生效，终于找到原因了
• 在配置需要忽略的端点的时候还要加上GET、POST这样的Method前缀

方式二：启动参数

-javaagent:../skywalking-agent.jar=agent.service_name=SkyWalkingDemo,trace.ignore_path='GET:/health' -Dskywalking.trace.ignore_path=/health

效果截图

指定的path忽略生效后，就没有再上送追踪数据了

参考资料

• Support custom trace ignore
• SkyWalking配置:忽略采集跟踪路径