skywalking-java/apm-sniffer/optional-plugins/trace-ignore-plugin
Wu Sheng 53e8608832 Merge branch 'master' into 6.0
# Conflicts:
#	.gitignore
#	LICENSE
#	README.md
#	README_ZH.md
#	apm-application-toolkit/apm-toolkit-log4j-1.x/pom.xml
#	apm-application-toolkit/apm-toolkit-log4j-2.x/pom.xml
#	apm-application-toolkit/apm-toolkit-logback-1.x/pom.xml
#	apm-application-toolkit/apm-toolkit-opentracing/pom.xml
#	apm-application-toolkit/apm-toolkit-trace/pom.xml
#	apm-application-toolkit/pom.xml
#	apm-checkstyle/pom.xml
#	apm-collector/apm-collector-agent/agent-grpc/agent-grpc-define/pom.xml
#	apm-collector/apm-collector-agent/agent-grpc/agent-grpc-provider/pom.xml
#	apm-collector/apm-collector-agent/agent-grpc/pom.xml
#	apm-collector/apm-collector-agent/agent-jetty/agent-jetty-define/pom.xml
#	apm-collector/apm-collector-agent/agent-jetty/agent-jetty-provider/pom.xml
#	apm-collector/apm-collector-agent/agent-jetty/pom.xml
#	apm-collector/apm-collector-agent/pom.xml
#	apm-collector/apm-collector-analysis/analysis-alarm/alarm-define/pom.xml
#	apm-collector/apm-collector-analysis/analysis-alarm/alarm-provider/pom.xml
#	apm-collector/apm-collector-analysis/analysis-alarm/pom.xml
#	apm-collector/apm-collector-analysis/analysis-baseline/baseline-computing-define/pom.xml
#	apm-collector/apm-collector-analysis/analysis-baseline/baseline-computing-provider/pom.xml
#	apm-collector/apm-collector-analysis/analysis-baseline/pom.xml
#	apm-collector/apm-collector-analysis/analysis-jvm/jvm-define/pom.xml
#	apm-collector/apm-collector-analysis/analysis-jvm/jvm-provider/pom.xml
#	apm-collector/apm-collector-analysis/analysis-jvm/pom.xml
#	apm-collector/apm-collector-analysis/analysis-metric/metric-define/pom.xml
#	apm-collector/apm-collector-analysis/analysis-metric/metric-provider/pom.xml
#	apm-collector/apm-collector-analysis/analysis-metric/pom.xml
#	apm-collector/apm-collector-analysis/analysis-register/pom.xml
#	apm-collector/apm-collector-analysis/analysis-register/register-define/pom.xml
#	apm-collector/apm-collector-analysis/analysis-register/register-provider/pom.xml
#	apm-collector/apm-collector-analysis/analysis-segment-parser/pom.xml
#	apm-collector/apm-collector-analysis/analysis-segment-parser/segment-parser-define/pom.xml
#	apm-collector/apm-collector-analysis/analysis-segment-parser/segment-parser-provider/pom.xml
#	apm-collector/apm-collector-analysis/analysis-worker-model/pom.xml
#	apm-collector/apm-collector-analysis/pom.xml
#	apm-collector/apm-collector-boot/pom.xml
#	apm-collector/apm-collector-boot/src/main/resources/component-libraries.yml
#	apm-collector/apm-collector-cache/collector-cache-caffeine-provider/pom.xml
#	apm-collector/apm-collector-cache/collector-cache-define/pom.xml
#	apm-collector/apm-collector-cache/collector-cache-guava-provider/pom.xml
#	apm-collector/apm-collector-cache/pom.xml
#	apm-collector/apm-collector-cluster/collector-cluster-define/pom.xml
#	apm-collector/apm-collector-cluster/collector-cluster-redis-provider/pom.xml
#	apm-collector/apm-collector-cluster/collector-cluster-standalone-provider/pom.xml
#	apm-collector/apm-collector-cluster/collector-cluster-zookeeper-provider/pom.xml
#	apm-collector/apm-collector-cluster/pom.xml
#	apm-collector/apm-collector-component/client-component/pom.xml
#	apm-collector/apm-collector-component/pom.xml
#	apm-collector/apm-collector-component/server-component/pom.xml
#	apm-collector/apm-collector-configuration/collector-configuration-define/pom.xml
#	apm-collector/apm-collector-configuration/collector-configuration-provider/pom.xml
#	apm-collector/apm-collector-configuration/pom.xml
#	apm-collector/apm-collector-core/pom.xml
#	apm-collector/apm-collector-grpc-manager/collector-grpc-manager-define/pom.xml
#	apm-collector/apm-collector-grpc-manager/collector-grpc-manager-provider/pom.xml
#	apm-collector/apm-collector-grpc-manager/pom.xml
#	apm-collector/apm-collector-instrument/pom.xml
#	apm-collector/apm-collector-jetty-manager/collector-jetty-manager-define/pom.xml
#	apm-collector/apm-collector-jetty-manager/collector-jetty-manager-provider/pom.xml
#	apm-collector/apm-collector-jetty-manager/pom.xml
#	apm-collector/apm-collector-naming/collector-naming-define/pom.xml
#	apm-collector/apm-collector-naming/collector-naming-jetty-provider/pom.xml
#	apm-collector/apm-collector-naming/pom.xml
#	apm-collector/apm-collector-remote/collector-remote-define/pom.xml
#	apm-collector/apm-collector-remote/collector-remote-grpc-provider/pom.xml
#	apm-collector/apm-collector-remote/collector-remote-kafka-provider/pom.xml
#	apm-collector/apm-collector-remote/pom.xml
#	apm-collector/apm-collector-storage/collector-storage-define/pom.xml
#	apm-collector/apm-collector-storage/collector-storage-es-provider/pom.xml
#	apm-collector/apm-collector-storage/collector-storage-h2-provider/pom.xml
#	apm-collector/apm-collector-storage/collector-storage-shardingjdbc-provider/pom.xml
#	apm-collector/apm-collector-storage/pom.xml
#	apm-collector/apm-collector-thirdparty-receiver/pom.xml
#	apm-collector/apm-collector-thirdparty-receiver/receiver-zipkin/pom.xml
#	apm-collector/apm-collector-thirdparty-receiver/receiver-zipkin/receiver-zipkin-define/pom.xml
#	apm-collector/apm-collector-thirdparty-receiver/receiver-zipkin/receiver-zipkin-provider/pom.xml
#	apm-collector/apm-collector-ui/collector-ui-define/pom.xml
#	apm-collector/apm-collector-ui/collector-ui-graphql/pom.xml
#	apm-collector/apm-collector-ui/collector-ui-jetty-provider/pom.xml
#	apm-collector/apm-collector-ui/pom.xml
#	apm-collector/pom.xml
#	apm-commons/apm-datacarrier/pom.xml
#	apm-commons/apm-util/pom.xml
#	apm-commons/pom.xml
#	apm-dist/pom.xml
#	apm-protocol/apm-network/pom.xml
#	apm-protocol/apm-network/src/main/java/org/apache/skywalking/apm/network/trace/component/ComponentsDefine.java
#	apm-protocol/apm-ui-protocol/pom.xml
#	apm-protocol/pom.xml
#	apm-sniffer/apm-agent-core/pom.xml
#	apm-sniffer/apm-agent/pom.xml
#	apm-sniffer/apm-sdk-plugin/activemq-5.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/dubbo-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/elastic-job-2.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/feign-default-http-9.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/grpc-1.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/h2-1.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/httpClient-4.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/httpasyncclient-4.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/hystrix-1.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/jdbc-commons/pom.xml
#	apm-sniffer/apm-sdk-plugin/jedis-2.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/jetty-plugin/jetty-client-9.0-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/jetty-plugin/jetty-client-9.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/jetty-plugin/jetty-server-9.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/jetty-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/kafka-v1-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/mongodb-2.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/mongodb-3.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/motan-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/mysql-5.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/nutz-plugins/http-1.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/nutz-plugins/mvc-annotation-1.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/nutz-plugins/pom.xml
#	apm-sniffer/apm-sdk-plugin/okhttp-3.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/oracle-10.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/postgresql-8.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/resin-3.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/resin-4.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/rocketMQ-3.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/rocketMQ-4.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/servicecomb-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/servicecomb-plugin/servicecomb-java-chassis-0.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/servicecomb-plugin/servicecomb-java-chassis-1.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/sharding-jdbc-1.5.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/sofarpc-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/spring-plugins/concurrent-util-4.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/spring-plugins/core-patch/pom.xml
#	apm-sniffer/apm-sdk-plugin/spring-plugins/mvc-annotation-3.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/spring-plugins/mvc-annotation-4.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/spring-plugins/mvc-annotation-commons/pom.xml
#	apm-sniffer/apm-sdk-plugin/spring-plugins/pom.xml
#	apm-sniffer/apm-sdk-plugin/spring-plugins/resttemplate-4.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/spring-plugins/spring-cloud/netflix-plugins/pom.xml
#	apm-sniffer/apm-sdk-plugin/spring-plugins/spring-cloud/netflix-plugins/spring-cloud-feign-1.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/spring-plugins/spring-cloud/pom.xml
#	apm-sniffer/apm-sdk-plugin/spymemcached-2.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/struts2-2.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/tomcat-7.x-8.x-plugin/pom.xml
#	apm-sniffer/apm-sdk-plugin/xmemcached-2.x-plugin/pom.xml
#	apm-sniffer/apm-test-tools/pom.xml
#	apm-sniffer/apm-toolkit-activation/apm-toolkit-log4j-1.x-activation/pom.xml
#	apm-sniffer/apm-toolkit-activation/apm-toolkit-log4j-2.x-activation/pom.xml
#	apm-sniffer/apm-toolkit-activation/apm-toolkit-logback-1.x-activation/pom.xml
#	apm-sniffer/apm-toolkit-activation/apm-toolkit-opentracing-activation/pom.xml
#	apm-sniffer/apm-toolkit-activation/apm-toolkit-trace-activation/pom.xml
#	apm-sniffer/apm-toolkit-activation/pom.xml
#	apm-sniffer/optional-plugins/optional-spring-plugins/pom.xml
#	apm-sniffer/optional-plugins/optional-spring-plugins/spring-annotation-plugin/pom.xml
#	apm-sniffer/optional-plugins/pom.xml
#	apm-sniffer/optional-plugins/trace-ignore-plugin/pom.xml
#	apm-sniffer/pom.xml
#	apm-webapp/pom.xml
#	docs/README.md
#	docs/README_ZH.md
#	docs/cn/Direct-uplink-CN.md
#	docs/cn/How-to-build-CN.md
#	docs/cn/Optional-plugins-CN.md
#	docs/users.md
#	pom.xml
2018-08-25 22:08:19 +08:00
..
src provides a optional-plugin for tracking ignores enhancement(#1203) (#1213) 2018-05-24 08:49:19 +08:00
README.md Change index page of Incubating and optional plugin documents (#1340) 2018-06-11 22:50:20 +08:00
README_CN.md Adjust and modify the catalog and doc under Supported-list.md (#1445) 2018-07-13 23:22:50 -07:00
apm-trace-ignore-plugin.config provides a optional-plugin for tracking ignores enhancement(#1203) (#1213) 2018-05-24 08:49:19 +08:00
pom.xml Sync mvnw to 6.0 , provided by @adriancole 2018-08-22 22:50:50 +08:00

README.md

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 rules to filter traces
trace.ignore_path=/your/path/1/**,/your/path/2/**