Project: SkyWalking (Observability and Analysis / Observability)
File: ui-grafana.md

SkyWalking provide since 9.4.0 and since 9.6.0. You can choose as the SkyWalking UI. About the installation and how to use please refer to the . Notice <1>, Gafana is , which is very different from Apache 2.0. Please follow AGPL 3.0 license requirements. Notice <2>, SkyWalking always uses its native UI as first class. All visualization features are only available on native UI. Grafana UI is an extension on our support of PromQL APIs. We don't maintain or promise the complete Grafana UI dashboard setup. 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"/> Before you start, please install the . 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"/> 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"/> The following steps are the example of config a `General Service` dashboard: Create a dashboard named `General Service`. A is recommended as a dashboard. Configure variables for the dashboard: <img src="https://skywalking.apache.org/screenshots/9.6.0/promql/grafana-variables.jpg"/> After configure, you can select the service/instance/endpoint on the top of the dashboard: <img src="https://skywalking.apache.org/screenshots/9.6.0/promql/grafana-variables2.jpg"/> The following contents show how to add several typical metrics panels. General settings: Chose the metrics and chart. Set `Query options --> Min interval = 1m`, because the metrics min time bucket in SkyWalking is 1m. Add PromQL expressions, use the variables configured above for the labels then you can select the labels value from top. Note: Some metrics values may be required calculations to match units. Select the returned labels you want to show on panel. Test query and save the panel. For example `service_apdex` and `Time series chart`. Add PromQL expression, the metric scope is `Service`, so add labels `service` and `layer` for match. Set `Connect null values --> Always` and `Show points --> Always` because when the query interval > 1hour or 1day SkyWalking return the hour/day step metrics values. <img src="https://skywalking.apache.org/screenshots/9.6.0/promql/grafana-panels.jpg"/> For example `service_percentile` and `Time series chart`. Add PromQL expressions, the metric scope is `Service`, add labels `service` and `layer` for

And it's a labeled value metric, add `labels='0,1,2,3,4'` filter the result label, and add`relabels='P50,P75,P90,P95,P99'` rename the result label. Set `Connect null values --> Always` and `Show points --> Always` because when the query interval > 1hour or 1day SkyWalking return the hour/day step metrics values. <img src="https://skywalking.apache.org/screenshots/9.6.0/promql/grafana-panels2.jpg"/> For example `serviceinstancecpm` and `Bar gauge chart`. Add PromQL expressions, add labels `parentservice` and `layer` for match, add `topn='10'` and `order='DES'` filter the result. Set the `Calculation --> Latest*`. <img src="https://skywalking.apache.org/screenshots/9.6.0/promql/grafana-panels3.jpg"/> Same as the Sort Metrics. 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"/> Chose the Node Graph chart. Set `Layer` and `Service` by the variables. If you want to show all services in this layer, set `Service` empty. 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"/> The following steps are the example of config a log dashboard: Create a dashboard named `Log`. Configure variables for the dashboard: <img src="https://skywalking.apache.org/screenshots/9.6.0/logql/grafana-loki-variables1.jpg"/> Please make sure `service_instance` and `endpoint` variable enabled `Include All` option and set `Custom all value` to * or blank (typed by space button on the keyboard): <img src="https://skywalking.apache.org/screenshots/9.6.0/logql/grafana-loki-variables2.jpg"/> `Tags` variable is a little different from others, for more details, please refer : <img src="https://skywalking.apache.org/screenshots/9.6.0/logql/grafana-loki-variables3.jpg"/> After configure, you can select log query variables on the top of the dashboard: <img src="https://skywalking.apache.org/screenshots/9.6.0/logql/grafana-loki-variables4.jpg"/> The following steps show how to add a log panel. Choose `Logs` chart. Set the `Line limit` value (The max number of logs to return in a query) and `Order` value (Determines the sort order of logs). Add LogQL expressions, use the variables configured above for the labels and searching keyword. `service_instance` & `endpoint` variable ref should use raw to prevent it value be escaped. Test query and save the panel. <img src="https://skywalking.apache.org/screenshots/9.6.0/logql/grafana-logs-panel.jpg"/> SkyWalking community provides a preview site for services of `General` and `Service Mesh` layers from the demo environment. You could take a glance through of the demo deployment. Notice, we don't provide all setups due to our monitoring target expanding fast. This demo is for helping you understand the above documents only.