Skip to content

Commit 8dde931

Browse files
authored
Correct missing package name in native manual API docs. (#449)
1 parent 492fb6e commit 8dde931

4 files changed

Lines changed: 16 additions & 15 deletions

File tree

CHANGES.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Release Notes.
1414
* Refactor pipeline in jedis-plugin.
1515

1616
#### Documentation
17-
* Update docs of Tracing APIs, reorganize the API docs into six parts
17+
* Update docs of Tracing APIs, reorganize the API docs into six parts.
18+
* Correct missing package name in native manual API docs.
1819

1920

2021
All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/168?closed=1)

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
* Use `TraceContext.traceId()` API to obtain traceId.
22
```java
3-
import TraceContext;
3+
import org.apache.skywalking.apm.toolkit.trace.TraceContext;
44
...
55

66
modelAndView.addObject("traceId", TraceContext.traceId());
77
```
88
* Use `TraceContext.segmentId()` API to obtain segmentId.
99
```java
10-
import TraceContext;
10+
import org.apache.skywalking.apm.toolkit.trace.TraceContext;
1111
...
1212

1313
modelAndView.addObject("segmentId", TraceContext.segmentId());
1414
```
1515

1616
* Use `TraceContext.spanId()` API to obtain spanId.
1717
```java
18-
import TraceContext;
18+
import org.apache.skywalking.apm.toolkit.trace.TraceContext;
1919
...
2020

2121
modelAndView.addObject("spanId", TraceContext.spanId());

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,22 @@
99

1010
* Use `TraceContext.traceId()` API to obtain traceId.
1111
```java
12-
import TraceContext;
12+
import org.apache.skywalking.apm.toolkit.trace.TraceContext;
1313
...
1414

1515
modelAndView.addObject("traceId", TraceContext.traceId());
1616
```
1717
* Use `TraceContext.segmentId()` API to obtain segmentId.
1818
```java
19-
import TraceContext;
19+
import org.apache.skywalking.apm.toolkit.trace.TraceContext;
2020
...
2121

2222
modelAndView.addObject("segmentId", TraceContext.segmentId());
2323
```
2424

2525
* Use `TraceContext.spanId()` API to obtain spanId.
2626
```java
27-
import TraceContext;
27+
import org.apache.skywalking.apm.toolkit.trace.TraceContext;
2828
...
2929

3030
modelAndView.addObject("spanId", TraceContext.spanId());

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* Use `Tracer.createEntrySpan()` API to create entry span, and then use `SpanRef` to contain the reference of created span in agent kernel. The first parameter is operation name of span and the second parameter is the `ContextCarrierRef` instance which is the reference of contextcarrier in agent kernel. If the second parameter is not null, the process of creating entry span will do the extract operation which will be introduced in **inject/extract** scenario.
44

55
```java
6-
import Tracer;
6+
import org.apache.skywalking.apm.toolkit.trace.Tracer;
77
...
88

99
SpanRef spanRef = Tracer.createEnteySpan("${operationName}", null);
@@ -12,7 +12,7 @@
1212
* Use `Tracer.createLocalSpan()` API to create local span, the only parameter is the operation name of span.
1313

1414
```java
15-
import Tracer;
15+
import org.apache.skywalking.apm.toolkit.trace.Tracer;
1616
...
1717

1818
SpanRef spanRef = Tracer.createLocalSpan("${operationName}");
@@ -23,7 +23,7 @@
2323
* **two parameters case**: the first parameter is the operation name of span, the second parameter is the remote peer which means the peer address of exit operation.
2424

2525
```java
26-
import Tracer;
26+
import org.apache.skywalking.apm.toolkit.trace.Tracer;
2727
...
2828

2929
SpanRef spanRef = Tracer.createExitSpan("${operationName}", "${remotePeer}");
@@ -34,7 +34,7 @@
3434
* Use `Tracer.stopSpan()` API to stop current span
3535

3636
```java
37-
import Tracer;
37+
import org.apache.skywalking.apm.toolkit.trace.Tracer;
3838
...
3939

4040
Tracer.stopSpan();
@@ -121,7 +121,7 @@ SpanRef spanRef = Tracer.createEntrySpan("${operationName}", contextCarrierRef);
121121
* Use `Tracer.capture()` to capture the segment info and store it in `ContextSnapshotRef`, and then use `Tracer.continued()` to load the snapshot as the ref segment info. The capture/continue is used for tracing context in the x-thread tracing.
122122

123123
```java
124-
import Tracer;
124+
import org.apache.skywalking.apm.toolkit.trace.Tracer;
125125
...
126126

127127
ContextSnapshotRef contextSnapshotRef = Tracer.capture();
@@ -140,7 +140,7 @@ SpanRef spanRef = Tracer.createEntrySpan("${operationName}", contextCarrierRef);
140140
* Use `log` of `SpanRef` instance to record log in span
141141

142142
```java
143-
import SpanRef;
143+
import org.apache.skywalking.apm.toolkit.trace.SpanRef;
144144
...
145145

146146
SpanRef spanRef = Tracer.createLocalSpan("${operationName}");
@@ -158,7 +158,7 @@ SpanRef spanRef = Tracer.createEntrySpan("${operationName}", contextCarrierRef);
158158
* Use `tag` of `SpanRef` instance to add tag to span, the parameters of tag are two String which are key and value respectively.
159159

160160
```java
161-
import SpanRef;
161+
import org.apache.skywalking.apm.toolkit.trace.SpanRef;
162162
...
163163

164164
SpanRef spanRef = Tracer.createLocalSpan(operationName);
@@ -170,7 +170,7 @@ SpanRef spanRef = Tracer.createEntrySpan("${operationName}", contextCarrierRef);
170170
* Use `prepareForAsync` of `SpanRef` instance to make the span still alive until `asyncFinish` called, and then in specific time use `asyncFinish` of this `SpanRef` instance to notify this span that it could be finished.
171171

172172
```java
173-
import SpanRef;
173+
import org.apache.skywalking.apm.toolkit.trace.SpanRef;
174174
...
175175

176176
SpanRef spanRef = Tracer.createLocalSpan("${operationName}");

0 commit comments

Comments
 (0)