提交 a7ecb9aa 编写于 作者: S SevenPointOld 提交者: wu-sheng

Add introduce doc to incubating features menu (#1265)

* provides a optional-plugin for tracking ignores enhancement(#1203)

* trace ignore plugin config support override by system.env

* optimize the trace ignore plugin and make normalization of pom

* add AntPathMatcher and an junit test for it

* No longer rely on the spring framework

* add license at file header

* rebuild pom and rewrite README

* rebuild optional-plugins pom

* clean up useless code

* modify junit

* rewrite the ant path match logic

* rename the matcher class

* add the trace ignore plugin introduce doc to incubating features menu.

* modify the README doc.

* remove Chinese in English doc.

* remove superfluous content of EN-doc.

* Update README.md
上级 5893dbe9
#How to use trace ignore plugin
Please copy the apm-trace-ignore-plugin-x.jar to `agent/plugins`
## Support custom trace ignore
Here is an optional plugin `apm-trace-ignore-plugin`
## Introduce
- The purpose of this plugin is to filter custom services which are expected to ignore from the tracing system.
- You can set up multiple URL path patterns, The services matches these patterns means won't be traced and analysis by agent and collector.
- The current matching rule follows `Ant Path` match style , like `/path/*`, `/path/**`, `/path/?`.
- Copy `apm-trace-ignore-plugin-x.jar` to `agent/plugins`, restarting the `agent` can effect the plugin.
## How to configure
There are two ways to configure ignore patterns. Settings through system env has higher priority.
1. Set through the system environment variable,you need to add `skywalking.trace.ignore_path` to the system variables, the value is the path that you need to ignore, multiple paths should be separated by `,`
2. Copy`/agent/optional-plugins/apm-trace-ignore-plugin/apm-trace-ignore-plugin.config` to `/agent/config/` dir, And add settings
```
trace.ignore_path=/your/path/1/**,/your/path/2/**
```
## How to set config
1. This plugin support reading config from environment variables(The env key must start with `skywalking.`, the reuslt should be as same as in `apm-trace-ignore-plugin.config`)
2. Or you can copy the `apm-trace-ignore-plugin.config` to `agent/config` then you'll set you need ignore paths in `apm-trace-ignore-plugin.config`
## 个性化服务过滤
提供了一个可选插件 `apm-trace-ignore-plugin`
## 介绍
- 这个插件的作用是对追踪的个性化服务过滤.
- 你可以设置多个需要忽略的路径, 意味着包含这些路径的`追踪信息`不会被`agent`发送到 `collector`.
- 当前的路径匹配规则是 `Ant Path`匹配风格 , 例如 `/path/*`, `/path/**`, `/path/?`.
-`apm-trace-ignore-plugin-x.jar`拷贝到`agent/plugins`后,重启探针即可生效
- [Skywalking-使用可选插件 apm-trace-ignore-plugin](https://blog.csdn.net/u013095337/article/details/80452088) 有详细使用介绍
## 如何配置路径
有两种配置方式,可使用任意一种,配置生效的优先级从高到低
1. 在系统环境变量中配置,你需要在系统变量中添加`skywalking.trace.ignore_path`, 值是你需要忽略的路径,多个以`,`号分隔
2.`/agent/optional-plugins/apm-trace-ignore-plugin/apm-trace-ignore-plugin.config` 复制或剪切到 `/agent/config/` 目录下,加上配置
```
trace.ignore_path=/your/path/1/**,/your/path/2/**
```
......@@ -52,6 +52,7 @@
<copy file="${project.basedir}/${project.name}.config" tofile="${optional.plugin.dest.dir}/${project.name}/${project.name}.config" overwrite="true" />
<!-- copy introduction -->
<copy file="${project.basedir}/README.md" tofile="${optional.plugin.dest.dir}/${project.name}/README.md" overwrite="true" />
<copy file="${project.basedir}/README_CN.md" tofile="${optional.plugin.dest.dir}/${project.name}/README_CN.md" overwrite="true" />
</tasks>
</configuration>
</execution>
......
......@@ -15,6 +15,7 @@
* [Add your own component library settings in collector](en/Component-libraries-extend.md)
* Incubating Features
* [Abstract](en/Incubating/Abstract.md)
* [Support Custom Trace Ignore](../apm-sniffer/optional-plugins/trace-ignore-plugin/README.md)
* Application Toolkit
* [Overview](en/Applicaton-toolkit.md)
* [OpenTracing Tracer](en/Opentracing.md)
......
......@@ -12,6 +12,8 @@
* [开启TLS](cn/TLS-CN.md)
* [命名空间隔离](cn/Namespace-CN.md)
* [基于Token认证](cn/Token-auth-CN.md)
* 孵化特性
* [个性化服务过滤](../apm-sniffer/optional-plugins/trace-ignore-plugin/README_CN.md)
* APM相关介绍资料
* [OpenTracing中文版](https://github.com/opentracing-contrib/opentracing-specification-zh)
* Application Toolkit,应用程序工具包
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册