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/04/04 13:28:19 UTC

[skywalking] 01/01: Add a doc for virtual database.

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

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

commit 26426dc3229000321f43ae3c0a7bf568d919810c
Author: Wu Sheng <wu...@foxmail.com>
AuthorDate: Mon Apr 4 21:28:02 2022 +0800

    Add a doc for virtual database.
---
 docs/en/setup/service-agent/virtual-database.md | 15 +++++++++++++++
 docs/menu.yml                                   |  4 ++++
 2 files changed, 19 insertions(+)

diff --git a/docs/en/setup/service-agent/virtual-database.md b/docs/en/setup/service-agent/virtual-database.md
new file mode 100644
index 0000000000..fcef2ca042
--- /dev/null
+++ b/docs/en/setup/service-agent/virtual-database.md
@@ -0,0 +1,15 @@
+# Virtual Database
+
+Virtual databases represents the database nodes detected by [server agents' plugins](server-agents.md). The performance
+metrics of the databases are also from Database client side perspective.
+
+For example, JDBC plugins(MySQL, PostgreSQL, Mariadb, MSSQL) in the Java agent could detect the latency of SQL
+performance, as well as SQL statements. As a result, in this dashboard, SkyWalking would show database traffic, latency,
+success rate and sampled slow SQLs powered by backend analysis capabilities.
+
+The Database access span should have
+- It is an **Exit** span
+- **Span's layer == DATABASE**
+- Tag key = `db.statement`, value = SQL statement
+- Tag key = `db.type`, value = the type of Database
+- Span's peer is the network address(IP or domain) of Database server.
diff --git a/docs/menu.yml b/docs/menu.yml
index 7d93562fc1..5f79779d95 100644
--- a/docs/menu.yml
+++ b/docs/menu.yml
@@ -165,6 +165,10 @@ catalog:
                 path: "/en/setup/backend/backend-vm-monitoring"
           - name: "Browser Monitoring"
             path: "/en/setup/service-agent/browser-agent"
+          - name: "Database Monitoring"
+            catalog:
+              - name: "Virtual Database"
+                path: "en/setup/service-agent/virtual-database"
           - name: "Self Observability"
             catalog:
               - name: "OAP Telemetry"