Google Git
Sign in
apache / skywalking-grafana-plugins / e2ef52c9bed65ebae0290afed7e5c89363624774
commite2ef52c9bed65ebae0290afed7e5c89363624774[log] [tgz]
authorFine0830 <fanxue0830@gmail.com>Tue May 16 16:26:03 2023 +0800
committerGitHub <noreply@github.com>Tue May 16 16:26:03 2023 +0800
tree5257a960a8dd8aa1588825a74b40ed075daedeb5
parent4fd0046e25307cc74ea5fe8feaf3cc799fea3180 [diff]
docs: file a release document (#12)
4 files changed
tree: 5257a960a8dd8aa1588825a74b40ed075daedeb5
  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. Makefile
  17. package.json
  18. README.md
  19. release.md
  20. tsconfig.json
  21. yarn.lock
README.md

Skywalking Grafana Plugins

SkyWalking Grafana Plugins provide extensions for Apache SkyWalking to visualize telemetry data on Grafana.

Currently, SkyWalking supports PromQL to establish Grafana metrics dashboard.

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+
> 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

Contact Us

  • Mail list: dev@skywalking.apache.org. Mail to dev-subscribe@skywalking.apache.org, follow the reply to subscribe the mail list.
  • Send Request to join SkyWalking slack mail to the mail list(dev@skywalking.apache.org), we will invite you in.
  • Twitter, ASFSkyWalking
  • QQ Group: 901167865, 392443393
  • bilibili B站 视频

License

Apache 2.0 License..

NOTICE, Grafana itself is licensed in GNU Affero General Public License v3.0.

Build the plugin from the source codes and run locally

  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