Google Git
Sign in
apache / skywalking-grafana-plugins / 3789ab7ef3af1aa306a133470541ed55ae619925
commit3789ab7ef3af1aa306a133470541ed55ae619925[log] [tgz]
authorFine0830 <fanxue0830@gmail.com>Thu May 11 21:17:17 2023 +0800
committerGitHub <noreply@github.com>Thu May 11 21:17:17 2023 +0800
treef95361db9489b32103342b72d675f570bf1c507c
parent45732953c6e098d467341d1e863c9519a26e1969 [diff]
docs: update README and bump Grafana from 9.3.8 to 9.5.1 (#2)
7 files changed
tree: f95361db9489b32103342b72d675f570bf1c507c
  1. .config/
  2. .github/
  3. cypress/
  4. src/
  5. .asf.yaml
  6. .DS_Store
  7. .eslintrc
  8. .gitignore
  9. .licenserc.yaml
  10. .prettierrc.js
  11. CHANGELOG.md
  12. docker-compose.yaml
  13. jest-setup.js
  14. jest.config.js
  15. LICENSE
  16. package.json
  17. README.md
  18. tsconfig.json
  19. yarn.lock
README.md

Skywalking Grafana Plugins

SkyWalking Grafana Plugins provides an extention for Apache SkyWalking visualizting telemetry data on Grafana.

Currently, SkyWalking supports PromQL to establish Grafana metrics dashboard. This plugin is focusing on more telemetry data, Service Map Topology.

This plugin provides a Grafana data source implementation.

Install the latest version of SkyWalking data source in your Grafana application

  • Require Grafana 9.5.1
> grafana-cli plugins install 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.

  1. Set the data source’s basic configuration options:
NameDescription
NameSets the name you use to refer to the data source in panels and queries.
URLSets the URL of the SkyWalking instance, such as http://skywalking.example.com/graphql.

Add Service Topology Graph

  1. Select the Dashboards tab.

  2. Select the Node Graph in the dashboard.

  3. Set the data source’s basic configuration options on the query tab:

NameExample(Value)Description
Layer$layerCurrent layer of services
Service$serviceCurrent 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

Getting started

  1. Install dependencies

    yarn install

  2. Build plugin in development mode and run in watch mode

    yarn dev

  3. Build plugin in production mode

    yarn build

  4. Run the tests (using Jest)

    # Runs the tests and watches for changes, requires git init first
yarn test

# Exits after running all the tests
yarn test:ci

  5. Spin up a Grafana instance and run the plugin inside it (using Docker)

    yarn server

  6. Run the E2E tests (using Cypress)

    # Spins up a Grafana instance first that we tests against 
yarn server

# Starts the tests
yarn e2e

  7. Run the linter

    yarn lint

# or

yarn lint:fix