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 2023/03/29 02:37:01 UTC
[skywalking-java] 01/01: Polish docs for preparing release.
This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch polish-docs
in repository https://gitbox.apache.org/repos/asf/skywalking-java.git
commit 0255a582b6d6bdb851210701ae4da68b7858e891
Author: Wu Sheng <wu...@foxmail.com>
AuthorDate: Wed Mar 29 10:36:50 2023 +0800
Polish docs for preparing release.
---
.../java-agent/Application-toolkit-dependency.md | 5 +++++
.../Application-toolkit-trace-correlation-context.md | 4 ++++
.../java-agent/Application-toolkit-trace-cross-thread.md | 15 ++++++++-------
.../java-agent/Application-toolkit-trace-read-context.md | 5 +++++
docs/en/setup/service-agent/java-agent/Opentracing.md | 7 +++++++
docs/menu.yml | 2 +-
6 files changed, 30 insertions(+), 8 deletions(-)
diff --git a/docs/en/setup/service-agent/java-agent/Application-toolkit-dependency.md b/docs/en/setup/service-agent/java-agent/Application-toolkit-dependency.md
index 17140f116f..0f50f7c2e7 100644
--- a/docs/en/setup/service-agent/java-agent/Application-toolkit-dependency.md
+++ b/docs/en/setup/service-agent/java-agent/Application-toolkit-dependency.md
@@ -1,4 +1,9 @@
Dependency the toolkit, such as using maven or gradle
+# Add Trace Toolkit
+[`apm-toolkit-trace`](https://mvnrepository.com/artifact/org.apache.skywalking/apm-toolkit-trace) provides the APIs to enhance the trace context,
+such as `createLocalSpan`, `createExitSpan`, `createEntrySpan`, `log`, `tag`, `prepareForAsync` and `asyncFinish`.
+Add the toolkit dependency to your project.
+
```xml
<dependency>
diff --git a/docs/en/setup/service-agent/java-agent/Application-toolkit-trace-correlation-context.md b/docs/en/setup/service-agent/java-agent/Application-toolkit-trace-correlation-context.md
index 20ca58e1ef..0484b101c9 100644
--- a/docs/en/setup/service-agent/java-agent/Application-toolkit-trace-correlation-context.md
+++ b/docs/en/setup/service-agent/java-agent/Application-toolkit-trace-correlation-context.md
@@ -1,3 +1,7 @@
+# Trace Correlation Context
+Trace correlation context APIs provide a way to put custom data in tracing context. All the data in
+the context will be propagated with the in-wire process automatically.
+
* Use `TraceContext.putCorrelation()` API to put custom data in tracing context.
```java
Optional<String> previous = TraceContext.putCorrelation("customKey", "customValue");
diff --git a/docs/en/setup/service-agent/java-agent/Application-toolkit-trace-cross-thread.md b/docs/en/setup/service-agent/java-agent/Application-toolkit-trace-cross-thread.md
index e5bbcbf5fa..7a35fd0282 100644
--- a/docs/en/setup/service-agent/java-agent/Application-toolkit-trace-cross-thread.md
+++ b/docs/en/setup/service-agent/java-agent/Application-toolkit-trace-cross-thread.md
@@ -1,6 +1,8 @@
-# trace cross thread
-There are some other ways to trace cross thread except the methods in `Tracer`.
-* usage 1.
+# Trace Cross Thread
+These APIs provide ways to continuous tracing in the cross thread scenario with minimal code changes.
+All following are sample codes only to demonstrate how to adopt cross thread cases easier.
+
+* Case 1.
```java
@TraceCrossThread
public static class MyCallable<String> implements Callable<String> {
@@ -13,7 +15,7 @@ There are some other ways to trace cross thread except the methods in `Tracer`.
ExecutorService executorService = Executors.newFixedThreadPool(1);
executorService.submit(new MyCallable());
```
-* usage 2.
+* Case 2.
```java
ExecutorService executorService = Executors.newFixedThreadPool(1);
executorService.submit(CallableWrapper.of(new Callable<String>() {
@@ -31,7 +33,7 @@ or
}
}));
```
-* usage 3.
+* Case 3.
```java
@TraceCrossThread
public class MySupplier<String> implements Supplier<String> {
@@ -49,7 +51,7 @@ or
return "SupplierWrapper";
})).thenAccept(System.out::println);
```
-* usage 4.
+* Case 4.
```java
CompletableFuture.supplyAsync(SupplierWrapper.of(() -> {
return "SupplierWrapper";
@@ -67,7 +69,6 @@ or
return "FunctionWrapper";
}));
```
-_Sample codes only_
diff --git a/docs/en/setup/service-agent/java-agent/Application-toolkit-trace-read-context.md b/docs/en/setup/service-agent/java-agent/Application-toolkit-trace-read-context.md
index 76bcdfd733..c6b9e197f4 100644
--- a/docs/en/setup/service-agent/java-agent/Application-toolkit-trace-read-context.md
+++ b/docs/en/setup/service-agent/java-agent/Application-toolkit-trace-read-context.md
@@ -1,3 +1,8 @@
+# Reading Context
+
+All following APIs provide **readonly** features for the tracing context from tracing system.
+The values are only available when the current thread is traced.
+
* Use `TraceContext.traceId()` API to obtain traceId.
```java
import org.apache.skywalking.apm.toolkit.trace.TraceContext;
diff --git a/docs/en/setup/service-agent/java-agent/Opentracing.md b/docs/en/setup/service-agent/java-agent/Opentracing.md
index e6215f1e94..cd311ca170 100644
--- a/docs/en/setup/service-agent/java-agent/Opentracing.md
+++ b/docs/en/setup/service-agent/java-agent/Opentracing.md
@@ -1,4 +1,11 @@
* Dependency the toolkit, such as using maven or gradle
+# OpenTracing (Deprecated)
+
+OpenTracing is a vendor-neutral standard for distributed tracing. It is a set of APIs that can be used to instrument, generate, collect, and report telemetry data for distributed systems. It is designed to be extensible so that new implementations can be created for new platforms or languages.
+It had been archived by the CNCF TOC. [Learn more](https://www.cncf.io/blog/2022/01/31/cncf-archives-the-opentracing-project/).
+
+SkyWalking community keeps the API compatible with 0.30.0 only. All further development will not be accepted.
+
```xml
<dependency>
<groupId>org.apache.skywalking</groupId>
diff --git a/docs/menu.yml b/docs/menu.yml
index e13aeadc0e..3964b059be 100644
--- a/docs/menu.yml
+++ b/docs/menu.yml
@@ -50,7 +50,7 @@ catalog:
path: "/en/setup/service-agent/java-agent/application-toolkit-trace-correlation-context"
- name: "Across Thread Solution"
path: "/en/setup/service-agent/java-agent/application-toolkit-trace-cross-thread"
- - name: "OpenTracing Tracer"
+ - name: "OpenTracing (Deprecated)"
path: "/en/setup/service-agent/java-agent/opentracing"
- name: "Meter APIs"
path: "/en/setup/service-agent/java-agent/application-toolkit-meter"