Skip to content

Commit f6a821a

Browse files
authored
Improve component-libraries documentation (#12814)
1 parent b832137 commit f6a821a

File tree

3 files changed

+32
-1
lines changed

3 files changed

+32
-1
lines changed

docs/en/changes/changes.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,5 +52,6 @@
5252
#### Documentation
5353
* Update release document to adopt newly added revision-based process.
5454
* Improve BanyanDB documentation.
55+
* Improve component-libraries documentation.
5556

5657
All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/224?closed=1)

docs/en/guides/Component-library-settings.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,36 @@ H2:
4949
languages: Java
5050
```
5151
52+
## Component Library Priority
53+
Component ID priority represents the component is degree of closeness between the library and business codes
54+
The higher the atomic number, the higher the priority, which mean it is closer to the business codes,
55+
further away from OS kernel or general Computer Science concept.
56+
57+
The range of priorities is [0, 100], both sided included. 0 is the lowest priority.
58+
To keep forward compatibility, the default(when not set) priority is 50.
59+
60+
For example, a typical priority sequence is TCP < TLS(TCP) < RPC < HTTP < HTTPS < gRPC/SpringMVC/Dubbo
61+
62+
Example:
63+
```yaml
64+
Unknown:
65+
id: 0
66+
language: All
67+
priority: 0
68+
tcp:
69+
id: 110
70+
languages: Java
71+
priority: 10
72+
https:
73+
id: 129
74+
languages: ebpf
75+
priority: 46
76+
tls:
77+
id: 130
78+
languages: ebpf, mesh
79+
priority: 11
80+
```
81+
5282
## Remote server mapping
5383
The remote server will be conjectured by the local component. The mappings are based on names in the component library.
5484

oap-server/server-starter/src/main/resources/component-libraries.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
# Component ID priority represents the component is degree of closeness between the library and business codes
3636
# The higher the atomic number, the higher the priority, which mean it is closer to the business codes,
3737
# further away from OS kernel or general Computer Science concept.
38-
# The range of priorities is [0, 100], both sided included. 0 is the highest priority.
38+
# The range of priorities is [0, 100], both sided included. 0 is the lowest priority.
3939
# To keep forward compatibility, the default(when not set) priority is 50.
4040
# For example, a typical priority sequence is TCP < TLS(TCP) < RPC < HTTP < HTTPS < gRPC/SpringMVC/Dubbo
4141

0 commit comments

Comments
 (0)