未验证 提交 00ffdf77 编写于 作者: wu-sheng's avatar wu-sheng 提交者: GitHub

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

上级 fb690941
......@@ -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)
......
# 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/).
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册