kazusa
/
skywalking-java
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update plugin test document for logging. (#294)

This commit is contained in:
jmjoy 2022-08-14 23:47:30 +08:00 committed by GitHub
parent 3e71ae4cdd
commit 115bcc1a3f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 57 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES.md
View File

@ -19,7 +19,8 @@ Release Notes.
#### Documentation
* Add a section in `Bootstrap-plugins` doc, introducing HttpURLConnection Plugin compatibility.
* Update `Plugin automatic test framework` ,fix inconsistent description about configuration.yml
* Update `Plugin automatic test framework`, fix inconsistent description about configuration.yml.
* Update `Plugin automatic test framework`, add expected data format of the log items.
All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/138?closed=1)

55
docs/en/setup/service-agent/java-agent/Plugin-test.md
View File

@ -331,6 +331,61 @@ The verify description for MeterId
| singleValue | counter or gauge value. Using condition operate of the number to validate, such as `gt`, `ge`. If current meter is histogram, don't need to write this field.
| histogramBuckets | histogram bucket. The bucket list must be ordered. The tool assert at least one bucket of the histogram having nonzero count. If current meter is counter or gauge, don't need to write this field.
**Expected Data Format Of The Log Items**
```yml
logItems:
-
serviceName: SERVICE_NAME(string)
logSize: LOG_SIZE(int)
logs:
- ...
```
| Field | Description
|-------------| ---
| serviceName | Service Name.
| logSize | The number of logs is expected.
| logs | log list. Follow the next section to see how to describe every log.
**Expected Data Format Of The Log**
```yml
timestamp: TIMESTAMP_VALUE(int)
endpoint: ENDPOINT_VALUE(int)
traceContext:
traceId: TRACE_ID_VALUE(string)
traceSegmentId: TRACE_SEGMENT_ID_VALUE(string)
spanId: SPAN_ID_VALUE(int)
body:
type: TYPE_VALUE(string)
content: # Choose one of three (text, json or yaml)
text: TEXT_VALUE(string)
# json: JSON_VALUE(string)
# yaml: YAML_VALUE(string)
tags:
data:
- key: TAG_KEY(string)
value: TAG_VALUE(string)
...
layer: LAYER_VALUE(string)
...
```
The verify description for Log
| Field | Description
|-----------------------------|---
| timestamp | log timestamp.
| endpoint | log endpoint.
| traceContext.traceId | log associated trace id.
| traceContext.traceSegmentId | log associated trace segment id.
| traceContext.spanId | log associated span id.
| body.type | log body type.
| body.content | log content, the sub field choose one of three (text, json or yaml).
| tags.data | log tags, key value pairs.
| layer | log layer.
### startup.sh
This script provide a start point to JVM based service, most of them starts by a `java -jar`, with some variables.