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

Add a guidance doc about the logic endpoint (#8216)

This commit is contained in:
吴晟 Wu Sheng 2021-11-30 21:06:47 +08:00 committed by GitHub
parent fb690941f6
commit 00ffdf77da
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 31 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES.md
View File

@ -88,6 +88,7 @@ Release Notes.
* Restructure documents about receivers and fetchers.
1. Remove general receiver and fetcher docs
2. Add more specific menu with docs to help users to find documents easier.
* Add a guidance doc about the logic endpoint.
All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/101?closed=1)

32
docs/en/guides/backend-oal-scripts.md
View File

@ -1,7 +1,35 @@
# Official OAL script
First, read the [OAL introduction](../concepts-and-designs/oal.md).
First, read the [OAL introduction](../concepts-and-designs/oal.md) to learn the OAL script grammar and the source concept.
From 8.0.0, you may find the OAL script at `/config/oal/*.oal` of the SkyWalking dist.
You could change it, such as by adding filter conditions or new metrics. Then, reboot the OAP server, and it will come into effect.
All metrics named in this script may be used in alarm and UI query.
All metrics named in this script could be used in alarm and UI query.
# Extension
## Logic Endpoint
In default, SkyWalking only treats the operation name of entry span as the endpoint, which are used in the OAL engine.
Users could declare their custom endpoint names by adding the `logic endpoint` tag manually through agent's plugins or manual APIs.
The logic endpoint is a concept that doesn't represent a real RPC call, but requires the statistic.
The value of `x-le` should be in JSON format. There are two options:
1. Define a new logic endpoint in the entry span as a separate new endpoint. Provide its own endpoint name, latency and status. Suitable for entry and local span.
```json
{
"name": "GraphQL-service",
"latency": 100,
"status": true
}
```
2. Declare the current local span representing a logic endpoint.
```json
{
"logic-span": true
}
```
### References
1. [Java plugin API](https://skywalking.apache.org/docs/skywalking-java/latest/en/setup/service-agent/java-agent/java-plugin-development-guide/#extension-logic-endpoint-tag-key-x-le) guides users to write plugins with logic endpoint.
2. Java agent's plugins include native included logic endpoints, also it provides ways to set the tag of logic span. The document could be found [here](https://skywalking.apache.org/docs/skywalking-java/latest/en/setup/service-agent/java-agent/logic-endpoint/).