[GitHub] wu-sheng closed pull request #1265: Add introduce doc to incubating features menu

[GitBox <gi...@apache.org>]

wu-sheng closed pull request #1265: Add introduce doc to incubating features menu
URL: https://github.com/apache/incubator-skywalking/pull/1265
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/apm-sniffer/optional-plugins/trace-ignore-plugin/README.md b/apm-sniffer/optional-plugins/trace-ignore-plugin/README.md
index b6950a9ea..55e4bb0e0 100644
--- a/apm-sniffer/optional-plugins/trace-ignore-plugin/README.md
+++ b/apm-sniffer/optional-plugins/trace-ignore-plugin/README.md
@@ -1,6 +1,17 @@
-#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`
diff --git a/apm-sniffer/optional-plugins/trace-ignore-plugin/README_CN.md b/apm-sniffer/optional-plugins/trace-ignore-plugin/README_CN.md
new file mode 100644
index 000000000..cc555ac80
--- /dev/null
+++ b/apm-sniffer/optional-plugins/trace-ignore-plugin/README_CN.md
@@ -0,0 +1,19 @@
+## 个性化服务过滤
+提供了一个可选插件 `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/**
+```
+
diff --git a/apm-sniffer/optional-plugins/trace-ignore-plugin/pom.xml b/apm-sniffer/optional-plugins/trace-ignore-plugin/pom.xml
index d348501ca..e92d681fc 100644
--- a/apm-sniffer/optional-plugins/trace-ignore-plugin/pom.xml
+++ b/apm-sniffer/optional-plugins/trace-ignore-plugin/pom.xml
@@ -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>
diff --git a/docs/README.md b/docs/README.md
index d0e62ee35..c58cdd2c4 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -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)
diff --git a/docs/README_ZH.md b/docs/README_ZH.md
index 82bae1332..0381fad01 100644
--- a/docs/README_ZH.md
+++ b/docs/README_ZH.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，应用程序工具包


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services