This is an automated email from the ASF dual-hosted git repository.
kezhenxu94 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking.git
The following commit(s) were added to refs/heads/master by this push:
new edf0bce Add logic endpoint section in the agent setup doc. (#5836)
edf0bce is described below
commit edf0bce37f682c093d1ea5bcca0a6d2d1ecc2cc4
Author: 吴晟 Wu Sheng <[email protected]>
AuthorDate: Fri Nov 13 10:05:38 2020 +0800
Add logic endpoint section in the agent setup doc. (#5836)
---
CHANGES.md | 1 +
docs/en/setup/service-agent/java-agent/README.md | 13 +++++++++++++
2 files changed, 14 insertions(+)
diff --git a/CHANGES.md b/CHANGES.md
index 85bb71d..da53a49 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -48,6 +48,7 @@ Release Notes.
#### Documentation
* Add VNode FAQ doc.
+* Add logic endpoint section in the agent setup doc.
* Adjust configuration names and system environment names of the sharing
server module
All issues and pull requests are
[here](https://github.com/apache/skywalking/milestone/62?closed=1)
diff --git a/docs/en/setup/service-agent/java-agent/README.md
b/docs/en/setup/service-agent/java-agent/README.md
index 1a9c9bd..144fee3 100755
--- a/docs/en/setup/service-agent/java-agent/README.md
+++ b/docs/en/setup/service-agent/java-agent/README.md
@@ -184,6 +184,19 @@ 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+
+## The Logic Endpoint
+In default, all the RPC server-side names as entry spans, such as RESTFul API
path and gRPC service name, would be endpoints with metrics.
+At the same time, SkyWalking introduces the logic endpoint concept, which
allows plugins and users to add new endpoints without adding new spans.
+The following logic endpoints are added automatically by plugins.
+1. GraphQL Query and Mutation are logic endpoints by using the names of them.
+1. Spring's ScheduledMethodRunnable jobs are logic endpoints. The name format
is `SpringScheduled`/`${className}`/`${methodName}`.
+1. Apache ShardingSphere ElasticJob's jobs are logic endpoints. The name
format is `ElasticJob`/`${jobName}`.
+1. XXLJob's jobs are logic endpoints. The name formats include
`xxl-job`/`MethodJob`/`${className}`.`${methodName}`,
`xxl-job`/`ScriptJob`/`${GlueType}`/`id`/`${jobId}`, and
`xxl-job`/`SimpleJob`/`${className}`.
+1. Quartz(optional plugin)'s jobs are logic endpoints. the name format is
`quartz-scheduler`/`${jobName}`.
+
+User could use the SkyWalking's application toolkits to add the tag into the
local span to label the span as a logic endpoint in the analysis stage.
+The tag is, key=`x-le` and value = `{"logic-span":true}`.
+
## Advanced Features
* Set the settings through system properties for config file override. Read
[setting override](Setting-override.md).
* Use gRPC TLS to link backend. See [open TLS](TLS.md)
