You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@skywalking.apache.org by wu...@apache.org on 2018/06/11 14:50:38 UTC
[incubator-skywalking] branch master updated: Change index page of
Incubating and optional plugin documents (#1340)
This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-skywalking.git
The following commit(s) were added to refs/heads/master by this push:
new 6529989 Change index page of Incubating and optional plugin documents (#1340)
6529989 is described below
commit 65299892e317cd9099ba5a05bb099bf8ac1f0a92
Author: 吴晟 Wu Sheng <wu...@foxmail.com>
AuthorDate: Mon Jun 11 22:50:20 2018 +0800
Change index page of Incubating and optional plugin documents (#1340)
* Reorganize incubating and optional docs.
---
.../optional-plugins/trace-ignore-plugin/README.md | 2 +-
docs/README.md | 6 ++++--
docs/en/Optional-plugins.md | 16 ----------------
docs/en/agent-optional-plugins/Oracle-Resin-plugins.md | 11 +++++++++++
docs/en/agent-optional-plugins/Spring-bean-plugins.md | 8 ++++++++
5 files changed, 24 insertions(+), 19 deletions(-)
diff --git a/apm-sniffer/optional-plugins/trace-ignore-plugin/README.md b/apm-sniffer/optional-plugins/trace-ignore-plugin/README.md
index 55e4bb0..89195e4 100644
--- a/apm-sniffer/optional-plugins/trace-ignore-plugin/README.md
+++ b/apm-sniffer/optional-plugins/trace-ignore-plugin/README.md
@@ -10,7 +10,7 @@ Here is an optional plugin `apm-trace-ignore-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
+ 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/**
```
diff --git a/docs/README.md b/docs/README.md
index 53e474e..4988fe9 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -8,6 +8,9 @@
* [Supported middlewares, frameworks and libraries](Supported-list.md)
* [How to disable plugins?](en/How-to-disable-plugin.md)
* [Optional plugins](en/Optional-plugins.md)
+ * [Trace Spring beans](en/agent-optional-plugins/Spring-bean-plugins.md)
+ * [Trace Oracle and Resin](en/agent-optional-plugins/Oracle-Resin-plugins.md)
+ * [[**Incubating**] Filter traces through custom services](../apm-sniffer/optional-plugins/trace-ignore-plugin/README.md)
* Advanced Features
* [Override settings through System.properties](en/Setting-override.md)
* [Direct uplink and disable naming discovery](en/Direct-uplink.md)
@@ -16,8 +19,7 @@
* [Token Authentication](en/Token-auth.md)
* [Add your own component library settings in collector](en/Component-libraries-extend.md)
* Incubating Features
- * [Abstract](en/Incubating/Abstract.md)
- * [Filter traces through custom services](../apm-sniffer/optional-plugins/trace-ignore-plugin/README.md)
+ * [Why are some features in **Incubating**?](en/Incubating/Abstract.md)
* Application Toolkit
* [Overview](en/Applicaton-toolkit.md)
* [Use SkyWalking OpenTracing compatible tracer](en/Opentracing.md)
diff --git a/docs/en/Optional-plugins.md b/docs/en/Optional-plugins.md
index d1f83f9..a8f889a 100644
--- a/docs/en/Optional-plugins.md
+++ b/docs/en/Optional-plugins.md
@@ -3,22 +3,6 @@ Optional plugins could be provided by source codes or in `optional-plugins` fold
For using these plugins, you need to compile source codes by yourself, or copy the certain plugins to `/plugins`.
-## Spring bean plugin
-This plugin allows to trace all methods of beans in Spring context, which are annotated with
-`@Bean`, `@Service`, `@Component` and `@Repository`.
-- Why does this plugin optional?
-Tracing all methods in Spring context all creates a lot of spans, which also spend more CPU, memory and network.
-Of course you want to have spans as many as possible, but please make sure your system payload can support these.
-
-## Oracle and Resin plugins
-These plugins can't be provided in Apache release because of Oracle and Resin Licenses.
-If you want to know details, please read [Apache license legal document](https://www.apache.org/legal/resolved.html)
-
-- How should we build these optional plugins in local?
-
-1. Resin 3: Download Resin 3.0.9 and place the jar at `/ci-dependencies/resin-3.0.9.jar`.
-1. Resin 4: Download Resin 4.0.41 and place the jar at `/ci-dependencies/resin-4.0.41.jar`.
-1. Oracle: Download Oracle OJDBC-14 Driver 10.2.0.4.0 and place the jar at `/ci-dependencies/ojdbc14-10.2.0.4.0.jar`.
diff --git a/docs/en/agent-optional-plugins/Oracle-Resin-plugins.md b/docs/en/agent-optional-plugins/Oracle-Resin-plugins.md
new file mode 100644
index 0000000..3776679
--- /dev/null
+++ b/docs/en/agent-optional-plugins/Oracle-Resin-plugins.md
@@ -0,0 +1,11 @@
+## Oracle and Resin plugins
+These plugins can't be provided in Apache release because of Oracle and Resin Licenses.
+If you want to know details, please read [Apache license legal document](https://www.apache.org/legal/resolved.html)
+
+- How should we build these optional plugins in local?
+
+1. Resin 3: Download Resin 3.0.9 and place the jar at `/ci-dependencies/resin-3.0.9.jar`.
+1. Resin 4: Download Resin 4.0.41 and place the jar at `/ci-dependencies/resin-4.0.41.jar`.
+1. Oracle: Download Oracle OJDBC-14 Driver 10.2.0.4.0 and place the jar at `/ci-dependencies/ojdbc14-10.2.0.4.0.jar`.
+
+If you have troubles for finding these files, find them [here](https://github.com/OpenSkywalking/skywalking-ci-assist/tree/master/jars)
diff --git a/docs/en/agent-optional-plugins/Spring-bean-plugins.md b/docs/en/agent-optional-plugins/Spring-bean-plugins.md
new file mode 100644
index 0000000..206c6de
--- /dev/null
+++ b/docs/en/agent-optional-plugins/Spring-bean-plugins.md
@@ -0,0 +1,8 @@
+## Spring bean plugin
+This plugin allows to trace all methods of beans in Spring context, which are annotated with
+`@Bean`, `@Service`, `@Component` and `@Repository`.
+
+- Why does this plugin optional?
+
+Tracing all methods in Spring context all creates a lot of spans, which also spend more CPU, memory and network.
+Of course you want to have spans as many as possible, but please make sure your system payload can support these.
--
To stop receiving notification emails like this one, please contact
wusheng@apache.org.