(skywalking) branch master updated: Improve component-libraries documentation (#12814)

[wu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

wusheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking.git


The following commit(s) were added to refs/heads/master by this push:
     new f6a821ad48 Improve component-libraries documentation (#12814)
f6a821ad48 is described below

commit f6a821ad480ec37ffafac4b4688d2af279d4a462
Author: wuwen <wu...@aliyun.com>
AuthorDate: Sat Nov 30 01:20:22 2024 +0800

    Improve component-libraries documentation (#12814)
---
 docs/en/changes/changes.md                         |  1 +
 docs/en/guides/Component-library-settings.md       | 30 ++++++++++++++++++++++
 .../src/main/resources/component-libraries.yml     |  2 +-
 3 files changed, 32 insertions(+), 1 deletion(-)

diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md
index d83dd4c5f9..9d021e01fc 100644
--- a/docs/en/changes/changes.md
+++ b/docs/en/changes/changes.md
@@ -52,5 +52,6 @@
 #### Documentation
 * Update release document to adopt newly added revision-based process.
 * Improve BanyanDB documentation.
+* Improve component-libraries documentation.
 
 All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/224?closed=1)
diff --git a/docs/en/guides/Component-library-settings.md b/docs/en/guides/Component-library-settings.md
index 52661aaaf0..a27df6eeb8 100644
--- a/docs/en/guides/Component-library-settings.md
+++ b/docs/en/guides/Component-library-settings.md
@@ -49,6 +49,36 @@ H2:
   languages: Java
 ```
 
+## Component Library Priority
+Component ID priority represents the component is degree of closeness between the library and business codes
+The higher the atomic number, the higher the priority, which mean it is closer to the business codes,
+further away from OS kernel or general Computer Science concept.
+
+The range of priorities is [0, 100], both sided included. 0 is the lowest priority.
+To keep forward compatibility, the default(when not set) priority is 50.
+
+For example, a typical priority sequence is TCP < TLS(TCP) < RPC < HTTP < HTTPS < gRPC/SpringMVC/Dubbo
+
+Example:
+```yaml
+Unknown:
+  id: 0
+  language: All
+  priority: 0
+tcp:
+  id: 110
+  languages: Java
+  priority: 10
+https:
+  id: 129
+  languages: ebpf
+  priority: 46
+tls:
+  id: 130
+  languages: ebpf, mesh
+  priority: 11 
+```
+
 ## Remote server mapping
 The remote server will be conjectured by the local component. The mappings are based on names in the component library.
 
diff --git a/oap-server/server-starter/src/main/resources/component-libraries.yml b/oap-server/server-starter/src/main/resources/component-libraries.yml
index c11247eca2..221d8603af 100644
--- a/oap-server/server-starter/src/main/resources/component-libraries.yml
+++ b/oap-server/server-starter/src/main/resources/component-libraries.yml
@@ -35,7 +35,7 @@
 # Component ID priority represents the component is degree of closeness between the library and business codes
 # The higher the atomic number, the higher the priority, which mean it is closer to the business codes,
 # further away from OS kernel or general Computer Science concept.
-# The range of priorities is [0, 100], both sided included. 0 is the highest priority.
+# The range of priorities is [0, 100], both sided included. 0 is the lowest priority.
 # To keep forward compatibility, the default(when not set) priority is 50.
 # For example, a typical priority sequence is TCP < TLS(TCP) < RPC < HTTP < HTTPS < gRPC/SpringMVC/Dubbo