Grafana Data Source Backend Plugin Template

This template is a starting point for building Grafana Data Source Backend Plugins

What is Grafana Data Source Backend Plugin?

Grafana supports a wide range of data sources, including Prometheus, MySQL, and even Datadog. There’s a good chance you can already visualize metrics from the systems you have set up. In some cases, though, you already have an in-house metrics solution that you’d like to add to your Grafana dashboards. Grafana Data Source Plugins enables integrating such solutions with Grafana.

For more information about backend plugins, refer to the documentation on Backend plugins.

Build a data source plugin

document on Build a data source plugin

Set up your environment

Before you can get started building plugins, you need to set up your environment for plugin development.

To discover plugins, Grafana scans a plugin directory, the location of which depends on your operating system.

Create a directory called grafana-plugins in your preferred workspace.

Find the plugins property in the Grafana configuration file and set the plugins property to the path of your grafana-plugins directory. Refer to the Grafana configuration documentation for more information.

[paths]
plugins = "/path/to/grafana-plugins"
Restart Grafana if it’s already running, to load the new configuration.

Alternative method: Docker

If you don’t want to install Grafana on your local machine, you can use Docker.

To set up Grafana for plugin development using Docker, run the following command:

docker run -d -p 3000:3000 -e GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=aliyun-sls-datasource -v "$(pwd)"/grafana-plugins:/var/lib/grafana/plugins --name=grafana grafana/grafana:7.0.0

Since Grafana only loads plugins on start-up, you need to restart the container whenever you add or remove a plugin.

docker restart grafana

Getting started

A data source backend plugin consists of both frontend and backend components.

Frontend

Install dependencies
```
yarn install
```
Build plugin in development mode or run in watch mode
```
yarn dev
```
or
```
yarn watch
```
Build plugin in production mode
```
yarn build
```

Backend

Update Grafana plugin SDK for Go dependency to the latest minor version:
```
go get -u github.com/grafana/grafana-plugin-sdk-go
go mod tidy
```
Build backend plugin binaries for Linux, Windows and Darwin:
```
mage -v
```
List all available Mage targets for additional commands:
```
mage -l
```

Learn more

Build a data source backend plugin tutorial
Grafana documentation
Grafana Tutorials - Grafana Tutorials are step-by-step guides that help you make the most of Grafana
Grafana UI Library - UI components to help you build interfaces using Grafana Design System
Grafana plugin SDK for Go

defulee/aliyun-rocketmq-plugin