BFergerson commented on a change in pull request #4706:
URL: https://github.com/apache/skywalking/pull/4706#discussion_r414980125
##########
File path: docs/en/guides/Plugin-test.md
##########
@@ -275,51 +251,47 @@ segments:
- {key: LOG_KEY(string), value: LOG_VALUE(string)}
...
peer: PEER(string)
- peerId: PEER_ID(int)
refs:
- {
- parentSpanId: PARENT_SPAN_ID(int),
+ traceId: TRACE_ID(string),
parentTraceSegmentId: PARENT_TRACE_SEGMENT_ID(string),
- entryServiceInstanceId: ENTRY_SERVICE_INSTANCE_ID(int)
- parentServiceInstanceId: PARENT_SERVICE_INSTANCE_ID(int),
- networkAddress: NETWORK_ADDRESS(string),
- networkAddressId: NETWORK_ADDRESS_ID(int),
+ parentSpanId: PARENT_SPAN_ID(int),
+ parentService: PARENT_SERVICE(string),
+ parentServiceInstance: PARENT_SERVICE_INSTANCE(string),
parentEndpoint: PARENT_ENDPOINT_NAME(string),
- parentEndpointId: PARENT_ENDPOINT_ID(int),
- entryEndpoint: ENTRY_ENDPOINT_NAME(string),
- entryServiceInstanceId: ENTRY_ENDPOINT_ID(int),
+ networkAddress: NETWORK_ADDRESS(string),
+ refType: REF_TYPE(string: CrossProcess, CrossThread)
}
...
```
| Field | Description
|--- |---
-| operationName | Span Operation Name
-| operationId | Should be 0 for now
+| operationName | Span Operation Name.
| parentSpanId | Parent span id. **Notice**: The parent span id of the first
span should be -1.
| spanId | Span Id. **Notice**, start from 0.
| startTime | Span start time. It is impossible to get the accurate time, not
0 should be enough.
| endTime | Span finish time. It is impossible to get the accurate time, not 0
should be enough.
| isError | Span status, true or false.
-| componentName | Component name, should be null in most cases, use component
id instead.
| componentId | Component id for your plugin.
| tags | Span tag list. **Notice**, Keep in the same order as the plugin coded.
| logs | Span log list. **Notice**, Keep in the same order as the plugin coded.
-| SpanLayer | Options, DB, RPC_FRAMEWORK, HTTP, MQ, CACHE
-| SpanType | Span type, options, Exit, Entry or Local
+| SpanLayer | Options, DB, RPC_FRAMEWORK, HTTP, MQ, CACHE.
+| SpanType | Span type, options, Exit, Entry or Local.
| peer | Remote network address, IP + port mostly. For exit span, this should
be required.
-| peerId | Not 0 for now.
-
-The verify description for SegmentRef,
+The verify description for SegmentRef
| Field | Description
|---- |----
+| traceId |
+| parentTraceSegmentId | Parent SegmentId, pointing to the segment id in the
parent segment.
| parentSpanId | Parent SpanID, pointing to the span id in the parent segment.
-| entryServiceInstanceId/parentServiceInstanceId | Not 0 should be enough
-| networkAddress/networkAddressId | The peer value of parent exit span.
`networkAddressId` should be 0, as the mock tool doesn't do register for real.
-| parentEndpoint/parentEndpointId | The endpoint of parent/downstream service.
Usually set `parentEndpoint` as literal string name, unless there is no parent
endpoint, set `parentEndpointId` as -1.
-| entryEndpoint/entryServiceInstanceId | The endpoint of first service in the
distributed chain. Usually set `entryEndpoint` as literal string name, unless
there is no endpoint at the entry service, set `entryServiceInstanceId` as -1.
+| parentService | The service of parent/downstream service name.
+| parentServiceInstance | The instance of parent/downstream service instance
name.
+| parentEndpoint | The endpoint of parent/downstream service.
+| networkAddress | The peer value of parent exit span.
+| refType | Ref type, options, CrossProcess or CrossThread .
Review comment:
```suggestion
| refType | Ref type, options, CrossProcess or CrossThread.
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
