Skip to content

Commit 89e5262

Browse files
authored
Polish docs for preparing release. (#490)
1 parent 1f30e38 commit 89e5262

File tree

7 files changed

+33
-8
lines changed

7 files changed

+33
-8
lines changed

.dlc.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@
2020
},
2121
{
2222
"pattern": "https://kotlinlang.org.*"
23+
},
24+
{
25+
"pattern": "^https://mvnrepository.com/"
2326
}
2427
],
2528
"timeout": "10s",

docs/en/setup/service-agent/java-agent/Application-toolkit-dependency.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
Dependency the toolkit, such as using maven or gradle
2+
# Add Trace Toolkit
3+
[`apm-toolkit-trace`](https://mvnrepository.com/artifact/org.apache.skywalking/apm-toolkit-trace) provides the APIs to enhance the trace context,
4+
such as `createLocalSpan`, `createExitSpan`, `createEntrySpan`, `log`, `tag`, `prepareForAsync` and `asyncFinish`.
5+
Add the toolkit dependency to your project.
6+
27

38
```xml
49
<dependency>

docs/en/setup/service-agent/java-agent/Application-toolkit-trace-correlation-context.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# Trace Correlation Context
2+
Trace correlation context APIs provide a way to put custom data in tracing context. All the data in
3+
the context will be propagated with the in-wire process automatically.
4+
15
* Use `TraceContext.putCorrelation()` API to put custom data in tracing context.
26
```java
37
Optional<String> previous = TraceContext.putCorrelation("customKey", "customValue");

docs/en/setup/service-agent/java-agent/Application-toolkit-trace-cross-thread.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# trace cross thread
2-
There are some other ways to trace cross thread except the methods in `Tracer`.
3-
* usage 1.
1+
# Trace Cross Thread
2+
These APIs provide ways to continuous tracing in the cross thread scenario with minimal code changes.
3+
All following are sample codes only to demonstrate how to adopt cross thread cases easier.
4+
5+
* Case 1.
46
```java
57
@TraceCrossThread
68
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`.
1315
ExecutorService executorService = Executors.newFixedThreadPool(1);
1416
executorService.submit(new MyCallable());
1517
```
16-
* usage 2.
18+
* Case 2.
1719
```java
1820
ExecutorService executorService = Executors.newFixedThreadPool(1);
1921
executorService.submit(CallableWrapper.of(new Callable<String>() {
@@ -31,7 +33,7 @@ or
3133
}
3234
}));
3335
```
34-
* usage 3.
36+
* Case 3.
3537
```java
3638
@TraceCrossThread
3739
public class MySupplier<String> implements Supplier<String> {
@@ -49,7 +51,7 @@ or
4951
return "SupplierWrapper";
5052
})).thenAccept(System.out::println);
5153
```
52-
* usage 4.
54+
* Case 4.
5355
```java
5456
CompletableFuture.supplyAsync(SupplierWrapper.of(() -> {
5557
return "SupplierWrapper";
@@ -67,7 +69,6 @@ or
6769
return "FunctionWrapper";
6870
}));
6971
```
70-
_Sample codes only_
7172

7273

7374

docs/en/setup/service-agent/java-agent/Application-toolkit-trace-read-context.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
# Reading Context
2+
3+
All following APIs provide **readonly** features for the tracing context from tracing system.
4+
The values are only available when the current thread is traced.
5+
16
* Use `TraceContext.traceId()` API to obtain traceId.
27
```java
38
import org.apache.skywalking.apm.toolkit.trace.TraceContext;

docs/en/setup/service-agent/java-agent/Opentracing.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
* Dependency the toolkit, such as using maven or gradle
2+
# OpenTracing (Deprecated)
3+
4+
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.
5+
It had been archived by the CNCF TOC. [Learn more](https://www.cncf.io/blog/2022/01/31/cncf-archives-the-opentracing-project/).
6+
7+
SkyWalking community keeps the API compatible with 0.30.0 only. All further development will not be accepted.
8+
29
```xml
310
<dependency>
411
<groupId>org.apache.skywalking</groupId>

docs/menu.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ catalog:
5050
path: "/en/setup/service-agent/java-agent/application-toolkit-trace-correlation-context"
5151
- name: "Across Thread Solution"
5252
path: "/en/setup/service-agent/java-agent/application-toolkit-trace-cross-thread"
53-
- name: "OpenTracing Tracer"
53+
- name: "OpenTracing (Deprecated)"
5454
path: "/en/setup/service-agent/java-agent/opentracing"
5555
- name: "Meter APIs"
5656
path: "/en/setup/service-agent/java-agent/application-toolkit-meter"

0 commit comments

Comments
 (0)