Skip to content

Commit 6529989

Browse files
authored
Change index page of Incubating and optional plugin documents (apache#1340)
* Reorganize incubating and optional docs.
1 parent 975c040 commit 6529989

File tree

5 files changed

+24
-19
lines changed

5 files changed

+24
-19
lines changed

apm-sniffer/optional-plugins/trace-ignore-plugin/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Here is an optional plugin `apm-trace-ignore-plugin`
1010
## How to configure
1111
There are two ways to configure ignore patterns. Settings through system env has higher priority.
1212
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 `,`
13-
2. Copy`/agent/optional-plugins/apm-trace-ignore-plugin/apm-trace-ignore-plugin.config` to `/agent/config/` dir, And add settings
13+
2. Copy`/agent/optional-plugins/apm-trace-ignore-plugin/apm-trace-ignore-plugin.config` to `/agent/config/` dir, and add rules to filter traces
1414
```
1515
trace.ignore_path=/your/path/1/**,/your/path/2/**
1616
```

docs/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
* [Supported middlewares, frameworks and libraries](Supported-list.md)
99
* [How to disable plugins?](en/How-to-disable-plugin.md)
1010
* [Optional plugins](en/Optional-plugins.md)
11+
* [Trace Spring beans](en/agent-optional-plugins/Spring-bean-plugins.md)
12+
* [Trace Oracle and Resin](en/agent-optional-plugins/Oracle-Resin-plugins.md)
13+
* [[**Incubating**] Filter traces through custom services](../apm-sniffer/optional-plugins/trace-ignore-plugin/README.md)
1114
* Advanced Features
1215
* [Override settings through System.properties](en/Setting-override.md)
1316
* [Direct uplink and disable naming discovery](en/Direct-uplink.md)
@@ -16,8 +19,7 @@
1619
* [Token Authentication](en/Token-auth.md)
1720
* [Add your own component library settings in collector](en/Component-libraries-extend.md)
1821
* Incubating Features
19-
* [Abstract](en/Incubating/Abstract.md)
20-
* [Filter traces through custom services](../apm-sniffer/optional-plugins/trace-ignore-plugin/README.md)
22+
* [Why are some features in **Incubating**?](en/Incubating/Abstract.md)
2123
* Application Toolkit
2224
* [Overview](en/Applicaton-toolkit.md)
2325
* [Use SkyWalking OpenTracing compatible tracer](en/Opentracing.md)

docs/en/Optional-plugins.md

-16
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,6 @@ Optional plugins could be provided by source codes or in `optional-plugins` fold
33

44
For using these plugins, you need to compile source codes by yourself, or copy the certain plugins to `/plugins`.
55

6-
## Spring bean plugin
7-
This plugin allows to trace all methods of beans in Spring context, which are annotated with
8-
`@Bean`, `@Service`, `@Component` and `@Repository`.
96

10-
- Why does this plugin optional?
11-
Tracing all methods in Spring context all creates a lot of spans, which also spend more CPU, memory and network.
12-
Of course you want to have spans as many as possible, but please make sure your system payload can support these.
13-
14-
## Oracle and Resin plugins
15-
These plugins can't be provided in Apache release because of Oracle and Resin Licenses.
16-
If you want to know details, please read [Apache license legal document](https://www.apache.org/legal/resolved.html)
17-
18-
- How should we build these optional plugins in local?
19-
20-
1. Resin 3: Download Resin 3.0.9 and place the jar at `/ci-dependencies/resin-3.0.9.jar`.
21-
1. Resin 4: Download Resin 4.0.41 and place the jar at `/ci-dependencies/resin-4.0.41.jar`.
22-
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`.
237

248

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## Oracle and Resin plugins
2+
These plugins can't be provided in Apache release because of Oracle and Resin Licenses.
3+
If you want to know details, please read [Apache license legal document](https://www.apache.org/legal/resolved.html)
4+
5+
- How should we build these optional plugins in local?
6+
7+
1. Resin 3: Download Resin 3.0.9 and place the jar at `/ci-dependencies/resin-3.0.9.jar`.
8+
1. Resin 4: Download Resin 4.0.41 and place the jar at `/ci-dependencies/resin-4.0.41.jar`.
9+
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`.
10+
11+
If you have troubles for finding these files, find them [here](https://github.com/OpenSkywalking/skywalking-ci-assist/tree/master/jars)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Spring bean plugin
2+
This plugin allows to trace all methods of beans in Spring context, which are annotated with
3+
`@Bean`, `@Service`, `@Component` and `@Repository`.
4+
5+
- Why does this plugin optional?
6+
7+
Tracing all methods in Spring context all creates a lot of spans, which also spend more CPU, memory and network.
8+
Of course you want to have spans as many as possible, but please make sure your system payload can support these.

0 commit comments

Comments
 (0)