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/05/20 13:52:14 UTC
[skywalking] 01/01: Polish agent doc menu.
This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch polish-doc
in repository https://gitbox.apache.org/repos/asf/skywalking.git
commit 83a2e1b4789e7f46f13234a92306fdacd51bda48
Author: Wu Sheng <wu...@foxmail.com>
AuthorDate: Thu May 20 21:51:43 2021 +0800
Polish agent doc menu.
---
docs/en/setup/service-agent/java-agent/README.md | 9 +-----
docs/menu.yml | 40 +++++++++++++++++++++++-
2 files changed, 40 insertions(+), 9 deletions(-)
diff --git a/docs/en/setup/service-agent/java-agent/README.md b/docs/en/setup/service-agent/java-agent/README.md
index 337d1f5..c5fd39d 100755
--- a/docs/en/setup/service-agent/java-agent/README.md
+++ b/docs/en/setup/service-agent/java-agent/README.md
@@ -37,7 +37,6 @@ 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.
-## Advanced features
- All plugins are in `/plugins` folder. The plugin jar is active when it is in there. Remove the plugin jar, it disabled.
- The default logging output folder is `/logs`.
@@ -221,12 +220,11 @@ The tag is, key=`x-le` and value = `{"logic-span":true}`.
* Application Toolkit, are a collection of libraries, provided by SkyWalking APM. Using them, you have a bridge between your application and SkyWalking APM agent.
* If you want your codes to interact with SkyWalking agent, including `getting trace id`, `setting tags`, `propagating custom data` etc.. Try [SkyWalking manual APIs](Application-toolkit-trace.md).
* If you require customized metrics, try [SkyWalking Meter System Toolkit](Application-toolkit-meter.md).
- * If you want to print trace context(e.g. traceId) in your logs, or collect logs, choose the log frameworks, [log4j](Application-toolkit-log4j-1.x.md),
-[log4j2](Application-toolkit-log4j-2.x.md), [logback](Application-toolkit-logback-1.x.md)
* If you want to continue traces across thread manually, use [across thread solution APIs](Application-toolkit-trace-cross-thread.md).
* If you want to forward MicroMeter/Spring Sleuth metrics to Meter System, use [SkyWalking MicroMeter Register](Application-toolkit-micrometer.md).
* If you want to use OpenTracing Java APIs, try [SkyWalking OpenTracing compatible tracer](Opentracing.md). More details you could find at http://opentracing.io
* If you want to tolerate some exceptions, read [tolerate custom exception doc](How-to-tolerate-exceptions.md).
+ * If you want to print trace context(e.g. traceId) in your logs, or collect logs, choose the log frameworks, [log4j](Application-toolkit-log4j-1.x.md), [log4j2](Application-toolkit-log4j-2.x.md), [logback](Application-toolkit-logback-1.x.md).
* If you want to specify the path of your agent.config file. Read [set config file through system properties](Specified-agent-config.md)
## Advanced Reporters
@@ -237,8 +235,3 @@ The advanced report provides an alternative way to submit the agent collected da
## Plugin Development Guide
SkyWalking java agent supports plugin to extend [the supported list](Supported-list.md). Please follow
our [Plugin Development Guide](../../../guides/Java-Plugin-Development-Guide.md).
-
-# Test
-If you are interested in plugin compatible tests or agent performance, see the following reports.
-* [Plugin Test in every Pull Request](https://github.com/apache/skywalking/actions?query=workflow%3APluginsTest)
-* [Java Agent Performance Test](https://skyapmtest.github.io/Agent-Benchmarks/)
diff --git a/docs/menu.yml b/docs/menu.yml
index 3ce156d..335179b 100644
--- a/docs/menu.yml
+++ b/docs/menu.yml
@@ -69,10 +69,48 @@ catalog:
path: "/en/setup/service-agent/java-agent/Supported-list"
- name: "Agent Configuration Properties"
path: "/en/setup/service-agent/java-agent/readme#table-of-agent-configuration-properties"
- - name: "Optional plugins"
+ - name: "Dynamic Configurations"
+ path: "/en/setup/service-agent/java-agent/readme#dynamic-configurations"
+ - name: "Optional Plugins"
path: "/en/setup/service-agent/java-agent/readme#optional-plugins"
- name: "Bootstrap/JVM class plugin"
path: "/en/setup/service-agent/java-agent/readme#bootstrap-class-plugins"
+ - name: "Logic Endpoint"
+ path: "/en/setup/service-agent/java-agent/readme/#the-logic-endpoint"
+ - name: "Advanced Features"
+ catalog:
+ - name: "Guidance"
+ path: "/en/setup/service-agent/java-agent/readme/#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: "Advanced reporters"
path: "/en/setup/service-agent/java-agent/readme#advanced-reporters"
- name: "Plugin development guide"