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 337a54603b Update doc: Add topology configuration in UI-Grafana doc
(#11322)
337a54603b is described below
commit 337a54603b05a0ad6fb756a00f5d6741621cc889
Author: Wan Kai <[email protected]>
AuthorDate: Wed Sep 13 11:32:01 2023 +0800
Update doc: Add topology configuration in UI-Grafana doc (#11322)
---
docs/en/changes/changes.md | 1 +
docs/en/setup/backend/ui-grafana.md | 18 ++++++++++++++++++
2 files changed, 19 insertions(+)
diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md
index 8e1dace43c..d5287d4c40 100644
--- a/docs/en/changes/changes.md
+++ b/docs/en/changes/changes.md
@@ -15,6 +15,7 @@
#### Documentation
* Separate storage docs to different files, and add an estimated timeline for
BanyanDB(end of 2023).
+* Add topology configuration in UI-Grafana doc.
All issues and pull requests are
[here](https://github.com/apache/skywalking/milestone/193?closed=1)
diff --git a/docs/en/setup/backend/ui-grafana.md
b/docs/en/setup/backend/ui-grafana.md
index 1b3a35fae7..064757dc5d 100644
--- a/docs/en/setup/backend/ui-grafana.md
+++ b/docs/en/setup/backend/ui-grafana.md
@@ -13,6 +13,11 @@ Grafana UI is an extension on our support of PromQL APIs. We
don't maintain or p
In the data source config panel, chose the `Prometheus` and set the url to the
OAP server address, the default port is `9090`.
<img
src="https://skywalking.apache.org/screenshots/9.6.0/promql/grafana-datasource.jpg"/>
+### SkyWalking Data Source
+Before you start, please install the [SkyWalking data source
plugin](https://github.com/apache/skywalking-grafana-plugins).
+In the data source config panel, chose the `SkyWalking` and set the url to the
OAP server `graphql` service address, the default port is `12800`.
+<img
src="https://skywalking.apache.org/screenshots/9.7.0/promql/grafana-skywalking-datasource.jpg"/>
+
### Loki Data Source
In the data source config panel, chose the `Loki` and set the url to the OAP
server address, the default port is `3100`.
<img
src="https://skywalking.apache.org/screenshots/9.6.0/logql/grafana-loki-datasource.jpg"/>
@@ -60,6 +65,19 @@ General settings:
#### Sampled Records
Same as the Sort Metrics.
+## Configure Topology Dashboards
+
+### Dashboards Settings
+For now, SkyWalking support `General Service` and `Service Mesh` topology
dashboards, the layer is `GENERAL` and `MESH` respectively.
+The following configuration can reuse the above `General Service` dashboard
and add a new variable `Plugin_SkyWalking` for the dashboard:
+<img
src="https://skywalking.apache.org/screenshots/9.7.0/promql/grafana-variables-plugin-sw.jpg"/>
+
+### Add Topology Panel
+1. Chose the Node Graph chart.
+2. Set `Layer` and `Service` by the variables. If you want to show all
services in this layer, set `Service` empty.
+3. Set `Node Metrics` and `Edge Metrics` which you want to show on the
topology.
+<img
src="https://skywalking.apache.org/screenshots/9.7.0/promql/grafana-panels-topology.jpg"/>
+
## Configure Log Dashboard
### Dashboards Settings
The following steps are the example of config a log dashboard: