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/02/03 14:10:02 UTC
[skywalking-java] branch main updated: Correct missing package name in native manual API docs. (#449)
This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/skywalking-java.git
The following commit(s) were added to refs/heads/main by this push:
new 8dde931b72 Correct missing package name in native manual API docs. (#449)
8dde931b72 is described below
commit 8dde931b728e82339df1f7eff5b808dd88a66024
Author: 吴晟 Wu Sheng <wu...@foxmail.com>
AuthorDate: Fri Feb 3 22:09:56 2023 +0800
Correct missing package name in native manual API docs. (#449)
---
CHANGES.md | 3 ++-
.../java-agent/Application-toolkit-trace-read-context.md | 6 +++---
.../java-agent/Application-toolkit-trace.md | 6 +++---
.../java-agent/Application-toolkit-tracer.md | 16 ++++++++--------
4 files changed, 16 insertions(+), 15 deletions(-)
diff --git a/CHANGES.md b/CHANGES.md
index 1cd619979a..b3f28ffc94 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -14,7 +14,8 @@ Release Notes.
* Refactor pipeline in jedis-plugin.
#### Documentation
-* Update docs of Tracing APIs, reorganize the API docs into six parts
+* Update docs of Tracing APIs, reorganize the API docs into six parts.
+* Correct missing package name in native manual API docs.
All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/168?closed=1)
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 67a5195e9c..76bcdfd733 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,13 +1,13 @@
* Use `TraceContext.traceId()` API to obtain traceId.
```java
-import TraceContext;
+import org.apache.skywalking.apm.toolkit.trace.TraceContext;
...
modelAndView.addObject("traceId", TraceContext.traceId());
```
* Use `TraceContext.segmentId()` API to obtain segmentId.
```java
-import TraceContext;
+import org.apache.skywalking.apm.toolkit.trace.TraceContext;
...
modelAndView.addObject("segmentId", TraceContext.segmentId());
@@ -15,7 +15,7 @@ modelAndView.addObject("segmentId", TraceContext.segmentId());
* Use `TraceContext.spanId()` API to obtain spanId.
```java
-import TraceContext;
+import org.apache.skywalking.apm.toolkit.trace.TraceContext;
...
modelAndView.addObject("spanId", TraceContext.spanId());
diff --git a/docs/en/setup/service-agent/java-agent/Application-toolkit-trace.md b/docs/en/setup/service-agent/java-agent/Application-toolkit-trace.md
index bb1de05c0d..b437da68ea 100644
--- a/docs/en/setup/service-agent/java-agent/Application-toolkit-trace.md
+++ b/docs/en/setup/service-agent/java-agent/Application-toolkit-trace.md
@@ -9,14 +9,14 @@
* Use `TraceContext.traceId()` API to obtain traceId.
```java
-import TraceContext;
+import org.apache.skywalking.apm.toolkit.trace.TraceContext;
...
modelAndView.addObject("traceId", TraceContext.traceId());
```
* Use `TraceContext.segmentId()` API to obtain segmentId.
```java
-import TraceContext;
+import org.apache.skywalking.apm.toolkit.trace.TraceContext;
...
modelAndView.addObject("segmentId", TraceContext.segmentId());
@@ -24,7 +24,7 @@ modelAndView.addObject("segmentId", TraceContext.segmentId());
* Use `TraceContext.spanId()` API to obtain spanId.
```java
-import TraceContext;
+import org.apache.skywalking.apm.toolkit.trace.TraceContext;
...
modelAndView.addObject("spanId", TraceContext.spanId());
diff --git a/docs/en/setup/service-agent/java-agent/Application-toolkit-tracer.md b/docs/en/setup/service-agent/java-agent/Application-toolkit-tracer.md
index 4efea69a96..75a214e176 100644
--- a/docs/en/setup/service-agent/java-agent/Application-toolkit-tracer.md
+++ b/docs/en/setup/service-agent/java-agent/Application-toolkit-tracer.md
@@ -3,7 +3,7 @@
* 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.
```java
- import Tracer;
+ import org.apache.skywalking.apm.toolkit.trace.Tracer;
...
SpanRef spanRef = Tracer.createEnteySpan("${operationName}", null);
@@ -12,7 +12,7 @@
* Use `Tracer.createLocalSpan()` API to create local span, the only parameter is the operation name of span.
```java
- import Tracer;
+ import org.apache.skywalking.apm.toolkit.trace.Tracer;
...
SpanRef spanRef = Tracer.createLocalSpan("${operationName}");
@@ -23,7 +23,7 @@
* **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.
```java
- import Tracer;
+ import org.apache.skywalking.apm.toolkit.trace.Tracer;
...
SpanRef spanRef = Tracer.createExitSpan("${operationName}", "${remotePeer}");
@@ -34,7 +34,7 @@
* Use `Tracer.stopSpan()` API to stop current span
```java
- import Tracer;
+ import org.apache.skywalking.apm.toolkit.trace.Tracer;
...
Tracer.stopSpan();
@@ -121,7 +121,7 @@ SpanRef spanRef = Tracer.createEntrySpan("${operationName}", contextCarrierRef);
* 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.
```java
- import Tracer;
+ import org.apache.skywalking.apm.toolkit.trace.Tracer;
...
ContextSnapshotRef contextSnapshotRef = Tracer.capture();
@@ -140,7 +140,7 @@ SpanRef spanRef = Tracer.createEntrySpan("${operationName}", contextCarrierRef);
* Use `log` of `SpanRef` instance to record log in span
```java
- import SpanRef;
+ import org.apache.skywalking.apm.toolkit.trace.SpanRef;
...
SpanRef spanRef = Tracer.createLocalSpan("${operationName}");
@@ -158,7 +158,7 @@ SpanRef spanRef = Tracer.createEntrySpan("${operationName}", contextCarrierRef);
* Use `tag` of `SpanRef` instance to add tag to span, the parameters of tag are two String which are key and value respectively.
```java
- import SpanRef;
+ import org.apache.skywalking.apm.toolkit.trace.SpanRef;
...
SpanRef spanRef = Tracer.createLocalSpan(operationName);
@@ -170,7 +170,7 @@ SpanRef spanRef = Tracer.createEntrySpan("${operationName}", contextCarrierRef);
* 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.
```java
- import SpanRef;
+ import org.apache.skywalking.apm.toolkit.trace.SpanRef;
...
SpanRef spanRef = Tracer.createLocalSpan("${operationName}");