Use Grafana As The UI
SkyWalking provide PromQL Service since 9.4.0 and LogQL Service since 9.6.0. You can choose Grafana as the SkyWalking UI. About the installation and how to use please refer to the official document.
Notice <1>, Gafana is AGPL-3.0 license, 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.
Configure Data Source
Prometheus Data Source
In the data source config panel, chose the Prometheus
and set the url to the OAP server address, the default port is 9090
.
SkyWalking Data Source
Before you start, please install the SkyWalking data source plugin.
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
.
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
.
Configure Metric Dashboards
Dashboards Settings
The following steps are the example of config a General Service
dashboard:
- Create a dashboard named
General Service
. A layer is recommended as a dashboard. - Configure variables for the dashboard: After configure, you can select the service/instance/endpoint on the top of the dashboard:
Add Panels
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.
Common Value Metrics
- For example
service_apdex
andTime series chart
. - Add PromQL expression, the metric scope is
Service
, so add labelsservice
andlayer
for match. - Set
Connect null values --> Always
andShow points --> Always
because when the query interval > 1hour or 1day SkyWalking return the hour/day step metrics values.
Labeled Value Metrics
- For example
service_percentile
andTime series chart
. - Add PromQL expressions, the metric scope is
Service
, add labelsservice
andlayer
for match. And it’s a labeled value metric, addlabels='0,1,2,3,4'
filter the result label, and addrelabels='P50,P75,P90,P95,P99'
rename the result label. - Set
Connect null values --> Always
andShow points --> Always
because when the query interval > 1hour or 1day SkyWalking return the hour/day step metrics values.
Sort Metrics
- For example
service_instance_cpm
andBar gauge chart
. - Add PromQL expressions, add labels
parent_service
andlayer
for match, addtop_n='10'
andorder='DES'
filter the result. - Set the
Calculation --> Latest*
.
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:
Add Topology Panel
- Chose the Node Graph chart.
- Set
Layer
andService
by the variables. If you want to show all services in this layer, setService
empty. - Set
Node Metrics
andEdge Metrics
which you want to show on the topology.
Configure Log Dashboard
Dashboards Settings
The following steps are the example of config a log dashboard:
- Create a dashboard named
Log
. - Configure variables for the dashboard:
- Please make sure
service_instance
andendpoint
variable enabledInclude All
option and setCustom all value
to * or blank (typed by space button on the keyboard): Tags
variable is a little different from others, for more details, please refer Ad hoc filters:- After configure, you can select log query variables on the top of the dashboard:
Add Log Panel
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) andOrder
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 variable-format-options to prevent it value be escaped. - Test query and save the panel.
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 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.