You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by wu...@apache.org on 2021/10/11 01:21:47 UTC
[skywalking-java] 01/01: Add new menu for the document,
and change the structure a little as it is an independent project.
This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch doc-polish
in repository https://gitbox.apache.org/repos/asf/skywalking-java.git
commit 3faaa972b90eb40d09a8003f134dfd96a60401ec
Author: Wu Sheng <wu...@foxmail.com>
AuthorDate: Mon Oct 11 09:21:37 2021 +0800
Add new menu for the document, and change the structure a little as it is an independent project.
---
.../service-agent/java-agent/Bootstrap-plugins.md | 7 ++
.../service-agent/java-agent/Optional-plugins.md | 22 ++++++
docs/en/setup/service-agent/java-agent/README.md | 70 +++++++------------
docs/menu.yml | 80 +++++++++++-----------
4 files changed, 92 insertions(+), 87 deletions(-)
diff --git a/docs/en/setup/service-agent/java-agent/Bootstrap-plugins.md b/docs/en/setup/service-agent/java-agent/Bootstrap-plugins.md
new file mode 100644
index 0000000..33fbe32
--- /dev/null
+++ b/docs/en/setup/service-agent/java-agent/Bootstrap-plugins.md
@@ -0,0 +1,7 @@
+# Bootstrap class plugins
+All bootstrap plugins are optional, due to unexpected risk. Bootstrap plugins are provided in `bootstrap-plugins` folder.
+For using these plugins, you need to put the target plugin jar file into `/plugins`.
+
+Now, we have the following known bootstrap plugins.
+* Plugin of JDK HttpURLConnection. Agent is compatible with JDK 1.8+
+* Plugin of JDK Callable and Runnable. Agent is compatible with JDK 1.8+
\ No newline at end of file
diff --git a/docs/en/setup/service-agent/java-agent/Optional-plugins.md b/docs/en/setup/service-agent/java-agent/Optional-plugins.md
new file mode 100644
index 0000000..c1b6fd1
--- /dev/null
+++ b/docs/en/setup/service-agent/java-agent/Optional-plugins.md
@@ -0,0 +1,22 @@
+# Optional Plugins
+Java agent plugins are all pluggable. Optional plugins could be provided in `optional-plugins` folder under agent or 3rd party repositories.
+For using these plugins, you need to put the target plugin jar file into `/plugins`.
+
+Now, we have the following known optional plugins.
+* [Plugin of tracing Spring annotation beans](agent-optional-plugins/Spring-annotation-plugin.md)
+* [Plugin of tracing Oracle and Resin](agent-optional-plugins/Oracle-Resin-plugins.md)
+* [Filter traces through specified endpoint name patterns](agent-optional-plugins/trace-ignore-plugin.md)
+* Plugin of Gson serialization lib in optional plugin folder.
+* Plugin of Zookeeper 3.4.x in optional plugin folder. The reason of being optional plugin is, many business irrelevant traces are generated, which cause extra payload to agents and backends. At the same time, those traces may be just heartbeat(s).
+* [Customize enhance](Customize-enhance-trace.md) Trace methods based on description files, rather than write plugin or change source codes.
+* Plugin of Spring Cloud Gateway 2.1.x in optional plugin folder. Please only active this plugin when you install agent in Spring Gateway. spring-cloud-gateway-2.x-plugin and spring-webflux-5.x-plugin are both required.
+* Plugin of Spring Transaction in optional plugin folder. The reason of being optional plugin is, many local span are generated, which also spend more CPU, memory and network.
+* [Plugin of Kotlin coroutine](agent-optional-plugins/Kotlin-Coroutine-plugin.md) provides the tracing across coroutines automatically. As it will add local spans to all across routines scenarios, Please assess the performance impact.
+* Plugin of quartz-scheduler-2.x in the optional plugin folder. The reason for being an optional plugin is, many task scheduling systems are based on quartz-scheduler, this will cause duplicate tracing and link different sub-tasks as they share the same quartz level trigger, such as ElasticJob.
+* Plugin of spring-webflux-5.x in the optional plugin folder. Please only activate this plugin when you use webflux alone as a web container. If you are using SpringMVC 5 or Spring Gateway, you don't need this plugin.
+* Plugin of mybatis-3.x in optional plugin folder. The reason of being optional plugin is, many local span are generated, which also spend more CPU, memory and network.
+* Plugin of sentinel-1.x in the optional plugin folder. The reason for being an optional plugin is, the sentinel plugin generates a large number of local spans, which have a potential performance impact.
+* Plugin of ehcache-2.x in the optional plugin folder. The reason for being an optional plugin is, this plugin enhanced cache framework, generates large number of local spans, which have a potential performance impact.
+* Plugin of guava-cache in the optional plugin folder. The reason for being an optional plugin is, this plugin enhanced cache framework, generates large number of local spans, which have a potential performance impact.
+* Plugin of fastjson serialization lib in optional plugin folder.
+* Plugin of jackson serialization lib in optional plugin folder.
\ No newline at end of file
diff --git a/docs/en/setup/service-agent/java-agent/README.md b/docs/en/setup/service-agent/java-agent/README.md
index 1d40bcc..e6c1b8f 100755
--- a/docs/en/setup/service-agent/java-agent/README.md
+++ b/docs/en/setup/service-agent/java-agent/README.md
@@ -1,11 +1,16 @@
# Setup java agent
+
1. Agent is available for JDK 8 - 14.
1. Find `agent` folder in SkyWalking release package
1. Set `agent.service_name` in `config/agent.config`. Could be any String in English.
-1. Set `collector.backend_service` in `config/agent.config`. Default point to `127.0.0.1:11800`, only works for local backend.
-1. Add `-javaagent:/path/to/skywalking-package/agent/skywalking-agent.jar` to JVM argument. And make sure to add it before the `-jar` argument.
+1. Set `collector.backend_service` in `config/agent.config`. Default point to `127.0.0.1:11800`, only works for local
+ backend.
+1. Add `-javaagent:/path/to/skywalking-package/agent/skywalking-agent.jar` to JVM argument. And make sure to add it
+ before the `-jar` argument.
+
+The agent release dist is included in Apache [official release](http://skywalking.apache.org/downloads/). New agent
+package looks like this.
-The agent release dist is included in Apache [official release](http://skywalking.apache.org/downloads/). New agent package looks like this.
```
+-- agent
+-- activations
@@ -33,72 +38,43 @@ The agent release dist is included in Apache [official release](http://skywalkin
- Start your application.
## Install javaagent FAQs
+
- Linux Tomcat 7, Tomcat 8, Tomcat 9
-Change the first line of `tomcat/bin/catalina.sh`.
+ Change the first line of `tomcat/bin/catalina.sh`.
+
```shell
CATALINA_OPTS="$CATALINA_OPTS -javaagent:/path/to/skywalking-agent/skywalking-agent.jar"; export CATALINA_OPTS
```
- Windows Tomcat 7, Tomcat 8, Tomcat 9
-Change the first line of `tomcat/bin/catalina.bat`.
+ Change the first line of `tomcat/bin/catalina.bat`.
+
```shell
set "CATALINA_OPTS=-javaagent:/path/to/skywalking-agent/skywalking-agent.jar"
```
- JAR file
-Add `-javaagent` argument to command line in which you start your app. eg:
+ Add `-javaagent` argument to command line in which you start your app. eg:
+
```shell
java -javaagent:/path/to/skywalking-agent/skywalking-agent.jar -jar yourApp.jar
```
- Jetty
-Modify `jetty.sh`, add `-javaagent` argument to command line in which you start your app. eg:
+ Modify `jetty.sh`, add `-javaagent` argument to command line in which you start your app. eg:
+
```shell
export JAVA_OPTIONS="${JAVA_OPTIONS} -javaagent:/path/to/skywalking-agent/skywalking-agent.jar"
```
# Plugins
-## Supported middleware, framework and library
-SkyWalking agent has supported various middlewares, frameworks and libraries.
-Read [supported list](Supported-list.md) to get them and supported version.
-If the plugin is in **Optional²** catalog, go to [optional plugins](#optional-plugins) section to learn how to active it.
+SkyWalking agent has supported various middlewares, frameworks and libraries. Read [supported list](Supported-list.md)
+to get them and supported version. If the plugin is in **Optional²** catalog, go
+to [optional plugins](Optional-plugins.md) and [bootstrap class plugin](Bootstrap-plugins.md) section to learn how to
+active it.
-- All plugins are in `/plugins` folder. The plugin jar is active when it is in there. Remove the plugin jar, it disabled.
+- All plugins in `/plugins` folder are active. Remove the plugin jar, it disabled.
- The default logging output folder is `/logs`.
-## Optional Plugins
-Java agent plugins are all pluggable. Optional plugins could be provided in `optional-plugins` folder under agent or 3rd party repositories.
-For using these plugins, you need to put the target plugin jar file into `/plugins`.
-
-Now, we have the following known optional plugins.
-* [Plugin of tracing Spring annotation beans](agent-optional-plugins/Spring-annotation-plugin.md)
-* [Plugin of tracing Oracle and Resin](agent-optional-plugins/Oracle-Resin-plugins.md)
-* [Filter traces through specified endpoint name patterns](agent-optional-plugins/trace-ignore-plugin.md)
-* Plugin of Gson serialization lib in optional plugin folder.
-* Plugin of Zookeeper 3.4.x in optional plugin folder. The reason of being optional plugin is, many business irrelevant traces are generated, which cause extra payload to agents and backends. At the same time, those traces may be just heartbeat(s).
-* [Customize enhance](Customize-enhance-trace.md) Trace methods based on description files, rather than write plugin or change source codes.
-* Plugin of Spring Cloud Gateway 2.1.x in optional plugin folder. Please only active this plugin when you install agent in Spring Gateway. spring-cloud-gateway-2.x-plugin and spring-webflux-5.x-plugin are both required.
-* Plugin of Spring Transaction in optional plugin folder. The reason of being optional plugin is, many local span are generated, which also spend more CPU, memory and network.
-* [Plugin of Kotlin coroutine](agent-optional-plugins/Kotlin-Coroutine-plugin.md) provides the tracing across coroutines automatically. As it will add local spans to all across routines scenarios, Please assess the performance impact.
-* Plugin of quartz-scheduler-2.x in the optional plugin folder. The reason for being an optional plugin is, many task scheduling systems are based on quartz-scheduler, this will cause duplicate tracing and link different sub-tasks as they share the same quartz level trigger, such as ElasticJob.
-* Plugin of spring-webflux-5.x in the optional plugin folder. Please only activate this plugin when you use webflux alone as a web container. If you are using SpringMVC 5 or Spring Gateway, you don't need this plugin.
-* Plugin of mybatis-3.x in optional plugin folder. The reason of being optional plugin is, many local span are generated, which also spend more CPU, memory and network.
-* Plugin of sentinel-1.x in the optional plugin folder. The reason for being an optional plugin is, the sentinel plugin generates a large number of local spans, which have a potential performance impact.
-* Plugin of ehcache-2.x in the optional plugin folder. The reason for being an optional plugin is, this plugin enhanced cache framework, generates large number of local spans, which have a potential performance impact.
-* Plugin of guava-cache in the optional plugin folder. The reason for being an optional plugin is, this plugin enhanced cache framework, generates large number of local spans, which have a potential performance impact.
-* Plugin of fastjson serialization lib in optional plugin folder.
-* Plugin of jackson serialization lib in optional plugin folder.
-
-## Bootstrap class plugins
-All bootstrap plugins are optional, due to unexpected risk. Bootstrap plugins are provided in `bootstrap-plugins` folder.
-For using these plugins, you need to put the target plugin jar file into `/plugins`.
-
-Now, we have the following known bootstrap plugins.
-* Plugin of JDK HttpURLConnection. Agent is compatible with JDK 1.6+
-* Plugin of JDK Callable and Runnable. Agent is compatible with JDK 1.6+
-
-
-## Plugin Development Guide
-SkyWalking java agent supports plugin to extend [the supported list](Supported-list.md). Please follow
-our [Plugin Development Guide](Java-Plugin-Development-Guide.md).
+
diff --git a/docs/menu.yml b/docs/menu.yml
index 2a4ee03..e5d07c3 100644
--- a/docs/menu.yml
+++ b/docs/menu.yml
@@ -24,54 +24,54 @@ catalog:
path: "/en/setup/service-agent/java-agent/containerization#docker"
- name: "Setup in Kubernetes"
path: "/en/setup/service-agent/java-agent/containerization#kubernetes"
+ - name: "Advanced Features"
+ catalog:
+ - name: "Guidance"
+ path: "/en/setup/service-agent/java-agent/advanced-features"
+ - name: "Setting Override"
+ path: "/en/setup/service-agent/java-agent/setting-override"
+ - name: "Transport Layer Security (TLS)"
+ path: "/en/setup/service-agent/java-agent/tls"
+ - name: "Namespace Isolation"
+ path: "/en/setup/service-agent/java-agent/namespace"
+ - name: "Token Authentication"
+ path: "/en/setup/service-agent/java-agent/token-auth"
+ - name: "Manual APIs"
+ catalog:
+ - name: "Tracing APIs"
+ path: "/en/setup/service-agent/java-agent/application-toolkit-trace"
+ - name: "OpenTracing Tracer"
+ path: "/en/setup/service-agent/java-agent/opentracing"
+ - name: "Meter APIs"
+ path: "/en/setup/service-agent/java-agent/application-toolkit-meter"
+ - name: "Across Thread Solution"
+ path: "/en/setup/service-agent/java-agent/application-toolkit-trace-cross-thread"
+ - name: "MicroMeter Registry"
+ path: "/en/setup/service-agent/java-agent/application-toolkit-micrometer"
+ - name: "Tolerate Custom Exceptions"
+ path: "/en/setup/service-agent/java-agent/how-to-tolerate-exceptions"
+ - name: "Log & Trace Correlation"
+ catalog:
+ - name: "Log4j"
+ path: "/en/setup/service-agent/java-agent/application-toolkit-log4j-1.x"
+ - name: "Log4j2"
+ path: "/en/setup/service-agent/java-agent/application-toolkit-log4j-2.x"
+ - name: "Logback"
+ path: "/en/setup/service-agent/java-agent/application-toolkit-logback-1.x/"
+ - name: "Logic Endpoint"
+ path: "/en/setup/service-agent/java-agent/logic-endpoint"
- name: "Plugins"
catalog:
- name: "Supported middleware, framework and library"
path: "/en/setup/service-agent/java-agent/Supported-list"
- name: "Optional Plugins"
- path: "/en/setup/service-agent/java-agent/readme#optional-plugins"
+ path: "/en/setup/service-agent/java-agent/Optional-plugins"
- name: "Bootstrap/JVM class plugin"
- path: "/en/setup/service-agent/java-agent/readme#bootstrap-class-plugins"
+ path: "/en/setup/service-agent/java-agent/Bootstrap-plugins"
- name: "Agent Configuration Properties"
- path: "/en/setup/service-agent/java-agent/configurations#table-of-agent-configuration-properties"
+ path: "/en/setup/service-agent/java-agent/configurations"
- name: "Dynamic Configurations"
- path: "/en/setup/service-agent/java-agent/configurations#dynamic-configurations"
- - name: "Logic Endpoint"
- path: "/en/setup/service-agent/java-agent/logic-endpoint"
- - name: "Advanced Features"
- catalog:
- - name: "Guidance"
- path: "/en/setup/service-agent/java-agent/advanced-features"
- - name: "Setting Override"
- path: "/en/setup/service-agent/java-agent/setting-override"
- - name: "Transport Layer Security (TLS)"
- path: "/en/setup/service-agent/java-agent/tls"
- - name: "Namespace Isolation"
- path: "/en/setup/service-agent/java-agent/namespace"
- - name: "Token Authentication"
- path: "/en/setup/service-agent/java-agent/token-auth"
- - name: "Manual APIs"
- catalog:
- - name: "Tracing APIs"
- path: "/en/setup/service-agent/java-agent/application-toolkit-trace"
- - name: "OpenTracing Tracer"
- path: "/en/setup/service-agent/java-agent/opentracing"
- - name: "Meter APIs"
- path: "/en/setup/service-agent/java-agent/application-toolkit-meter"
- - name: "Across Thread Solution"
- path: "/en/setup/service-agent/java-agent/application-toolkit-trace-cross-thread"
- - name: "MicroMeter Registry"
- path: "/en/setup/service-agent/java-agent/application-toolkit-micrometer"
- - name: "Tolerate Custom Exceptions"
- path: "/en/setup/service-agent/java-agent/how-to-tolerate-exceptions"
- - name: "Log & Trace Correlation"
- catalog:
- - name: "Log4j"
- path: "/en/setup/service-agent/java-agent/application-toolkit-log4j-1.x"
- - name: "Log4j2"
- path: "/en/setup/service-agent/java-agent/application-toolkit-log4j-2.x"
- - name: "Logback"
- path: "/en/setup/service-agent/java-agent/application-toolkit-logback-1.x/"
+ path: "/en/setup/service-agent/java-agent/configuration-discovery"
- name: "Advanced reporters"
path: "/en/setup/service-agent/java-agent/advanced-reporters"
- name: "Plugin development guide"