Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apache/skywalking-grafana-plugins
SkyWalking Grafana Plugins provide extensions for Apache SkyWalking to visualize telemetry data on Grafana.
https://github.com/apache/skywalking-grafana-plugins
apm grafana observability skywalking visualization
Last synced: 30 days ago
JSON representation
SkyWalking Grafana Plugins provide extensions for Apache SkyWalking to visualize telemetry data on Grafana.
- Host: GitHub
- URL: https://github.com/apache/skywalking-grafana-plugins
- Owner: apache
- License: apache-2.0
- Created: 2023-04-11T08:44:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-12T04:02:55.000Z (about 2 months ago)
- Last Synced: 2024-10-01T01:21:45.798Z (about 1 month ago)
- Topics: apm, grafana, observability, skywalking, visualization
- Language: TypeScript
- Homepage: https://skywalking.apache.org/
- Size: 2.53 MB
- Stars: 24
- Watchers: 39
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Skywalking Grafana Plugins
SkyWalking Grafana Plugins provide extensions for [Apache SkyWalking](https://skywalking.apache.org/) to visualize telemetry data on Grafana.
Currently, SkyWalking supports [PromQL](https://skywalking.apache.org/docs/main/next/en/api/promql-service/) to establish [Grafana metrics dashboard](https://skywalking.apache.org/docs/main/next/en/setup/backend/ui-grafana/).
The plugins are focusing on visualizing more telemetry data, e.g. Service Map Topology, as a new Grafana data source implementation.
## Install the latest version of SkyWalking data source in your Grafana application
* Require Grafana 9.5.1+
```bash
> grafana-cli plugins install apache-skywalking-datasource
```
## Configure the data source
To configure basic settings for the data source, complete the following steps:
1. Click Connections in the left-side menu.
2. Under Your connections, click Data sources.
3. Enter SkyWalking in the search bar.
4. Select SkyWalking.
The Settings tab of the data source is displayed.
5. Set the data source’s basic configuration options:
|Name|Description|
|----|----|
|Name|Sets the name you use to refer to the data source in panels and queries.|
|URL|Sets the URL of the SkyWalking instance, such as https://skywalking.example.com/graphql.|
## Add Service Topology Graph
1. Select the Dashboards tab.
2. Select the Node Graph in the dashboard.
5. Set the data source’s basic configuration options on the query tab:
|Name|Example(Value)|Description|
|----|----|----|
|Layer|[$layer](https://skywalking.apache.org/docs/main/next/en/setup/backend/ui-grafana/#dashboards-settings)|Current layer of services|
|Service|[$service](https://skywalking.apache.org/docs/main/next/en/setup/backend/ui-grafana/#dashboards-settings)|Current service|
|Node Metrics|`[{"name":"service_sla","calculation":"percentage","label":"Success Rate","unit":"%"}]`|Supports multiple metrics|
|Edge Metrics|`[{"name":"service_relation_server_cpm","label":"Client Load","unit":"cpm","type":"SERVER"}]`|Only supports maximum two metrics|
# Contact Us
* Mail list: **[email protected]**. Mail to `[email protected]`, follow the reply to subscribe the mail list.
* Send `Request to join SkyWalking slack` mail to the mail list(`[email protected]`), we will invite you in.
* For Chinese speaker, send `[CN] Request to join SkyWalking slack` mail to the mail list(`[email protected]`), we will invite you in.
* Twitter, [ASFSkyWalking](https://twitter.com/AsfSkyWalking)
* [bilibili B站 视频](https://space.bilibili.com/390683219)
# License
[Apache 2.0 License.](https://github.com/apache/skywalking-grafana-plugins/blob/main/LICENSE)
**NOTICE, Grafana itself is licensed in [GNU Affero General Public License v3.0](https://github.com/grafana/grafana/blob/v9.5.1/LICENSE).**