(skywalking) branch master updated: [doc] add general-relation grafana ui doc. (#12341)

[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 42164f6974 [doc] add general-relation grafana ui doc. (#12341)
42164f6974 is described below

commit 42164f6974ad7b5cf25733fe4ebd05388b0f2a4d
Author: yswdqz <74...@users.noreply.github.com>
AuthorDate: Wed Jun 19 09:14:01 2024 +0800

    [doc] add general-relation grafana ui doc. (#12341)
---
 docs/en/setup/backend/ui-grafana.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/docs/en/setup/backend/ui-grafana.md b/docs/en/setup/backend/ui-grafana.md
index 064757dc5d..45392ea074 100644
--- a/docs/en/setup/backend/ui-grafana.md
+++ b/docs/en/setup/backend/ui-grafana.md
@@ -101,6 +101,23 @@ to prevent it value be escaped.
 4. Test query and save the panel.
 <img src="https://skywalking.apache.org/screenshots/9.6.0/logql/grafana-logs-panel.jpg"/>
 
+## Configure Relation Dashboards
+### Dashboards Settings
+The following steps are the example of config a `General Relation` dashboard:
+1. Create a dashboard named `General Relation`.
+2. Configure variables for the dashboard:
+   <img src="https://skywalking.apache.org/screenshots/10.1.0/promql/grafana-relation-variables1.png"/>
+   After configure, you can select the service/instance/endpoint and the dest service/instance/endpoint on the top of the dashboard:
+   <img src="https://skywalking.apache.org/screenshots/10.1.0/promql/grafana-relation-variables2.png"/>
+### Add Relation Metrics Panel
+The following contents show how to add relation metric panels.
+1. Chose the metrics and chart.
+2. Set `Query options`, `Connect null values`, `Show points` and `Returned Labels`. Please refer `Configure Metric Dashboards` part.
+3. Add PromQL expression, For all scopes, set `Layer`, `Dest Layer`, `Service` and `Dest Service` by the variables. For service instance relation scope, extra set `Service Instance` and `Dest Service Instance`.
+For endpoint relation scope, extra set `Endpoint` and `Dest Endpoint`.
+4. Test query and save the panel.
+<img src="https://skywalking.apache.org/screenshots/10.1.0/promql/grafana-relation-panel.png"/>
+
 ## Preview on demo.skywalking.a.o
 SkyWalking community provides a preview site for services of `General` and `Service Mesh` layers from the demo environment.
 You could take a glance through [**Preview metrics on Grafana**](https://skywalking.apache.org/#demo) of the demo deployment.