You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by wu...@apache.org on 2022/09/11 12:47:02 UTC

[skywalking-java] branch main updated: Add docs for virtual database tags (#307)

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

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


The following commit(s) were added to refs/heads/main by this push:
     new d0aa2c5165 Add docs for virtual database tags (#307)
d0aa2c5165 is described below

commit d0aa2c516579e32b3285427ccbd609fbcedafec1
Author: 吴晟 Wu Sheng <wu...@foxmail.com>
AuthorDate: Sun Sep 11 20:46:57 2022 +0800

    Add docs for virtual database tags (#307)
    
    * Add docs for virtual database tags
    
    * Update CHANGES.md
---
 CHANGES.md                                                  |  3 ++-
 .../java-agent/Java-Plugin-Development-Guide.md             | 13 +++++++++++++
 2 files changed, 15 insertions(+), 1 deletion(-)

diff --git a/CHANGES.md b/CHANGES.md
index 46411e5ae4..bcd3a46f2c 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -15,7 +15,8 @@ Release Notes.
 #### Documentation
 
 * Update `configuration` doc about overriding default value as empty map/list accordingly.
-* Update plugin dev tags for cache relative tags
+* Update plugin dev tags for cache relative tags.
+* Add plugin dev docs for virtual database tags.
 
 All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/150?closed=1)
 
diff --git a/docs/en/setup/service-agent/java-agent/Java-Plugin-Development-Guide.md b/docs/en/setup/service-agent/java-agent/Java-Plugin-Development-Guide.md
index 20e9ce65ec..289a20efa6 100644
--- a/docs/en/setup/service-agent/java-agent/Java-Plugin-Development-Guide.md
+++ b/docs/en/setup/service-agent/java-agent/Java-Plugin-Development-Guide.md
@@ -186,6 +186,19 @@ The value of `x-le` should be in JSON format. There are two options:
 }
 ```
 
+#### Vitural Database Relative Tags
+SkyWalking analysis Database(SQL-like) performance metrics through the following tags.
+
+```java
+    public static final StringTag DB_TYPE = new StringTag(3, "db.type");
+    public static final StringTag DB_STATEMENT = new StringTag(5, "db.statement");
+```
+
+* `db.type` records database type, such as sql, cassandra, Elasticsearch. 
+* `db.statement`records the sql statement of the database access.
+
+Read [backend's virtual database doc](https://skywalking.apache.org/docs/main/next/en/setup/service-agent/virtual-database/) for more details. 
+
 #### Vitural Cache Relative Tags
 Skywalking analysis cache performance related metrics through the following tags.