Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grafana/grafana-starter-datasource-backend
A starter for Grafana data source plugins with a backend
https://github.com/grafana/grafana-starter-datasource-backend
grafana-plugin
Last synced: about 2 months ago
JSON representation
A starter for Grafana data source plugins with a backend
- Host: GitHub
- URL: https://github.com/grafana/grafana-starter-datasource-backend
- Owner: grafana
- License: apache-2.0
- Created: 2020-04-24T11:46:53.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-27T04:15:01.000Z (over 1 year ago)
- Last Synced: 2024-07-27T04:36:25.113Z (about 2 months ago)
- Topics: grafana-plugin
- Language: Go
- Homepage:
- Size: 1.34 MB
- Stars: 42
- Watchers: 131
- Forks: 8
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## ⚠️ Deprecated!
**This repository is deprecated.**
A more up-to-date version of examples is available here: https://github.com/grafana/grafana-plugin-examples
**Available examples:**
- [datasource-basic](https://github.com/grafana/grafana-plugin-examples/blob/master/examples/datasource-basic) - demonstrates how to build a basic data source plugin with a backend
- [datasource-http](https://github.com/grafana/grafana-plugin-examples/blob/master/examples/datasource-http) - demonstrates how to query data from HTTP-based APIs.
- [datasource-streaming-websocket](https://github.com/grafana/grafana-plugin-examples/blob/master/examples/datasource-streaming-websocket) - demonstrates how to create an event-based data source plugin using RxJS and web sockets.
---
# Grafana Data Source Backend Plugin Template
[](https://github.com/grafana/grafana-datasource-backend/actions?query=workflow%3A%22CI%22)
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](https://grafana.com/docs/grafana/latest/developers/plugins/backend/).
## Getting started
A data source backend plugin consists of both frontend and backend components.
### Frontend
1. Install dependencies
```bash
yarn install
```
2. Build plugin in development mode or run in watch mode
```bash
yarn dev
```
or
```bash
yarn watch
```
3. Build plugin in production mode
```bash
yarn build
```
### Backend
1. Update [Grafana plugin SDK for Go](https://grafana.com/docs/grafana/latest/developers/plugins/backend/grafana-plugin-sdk-for-go/) dependency to the latest minor version:
```bash
go get -u github.com/grafana/grafana-plugin-sdk-go
go mod tidy
```
2. Build backend plugin binaries for Linux, Windows and Darwin:
```bash
mage -v
```
3. List all available Mage targets for additional commands:
```bash
mage -l
```
## Learn more
- [Build a data source backend plugin tutorial](https://grafana.com/tutorials/build-a-data-source-backend-plugin)
- [Grafana documentation](https://grafana.com/docs/)
- [Grafana Tutorials](https://grafana.com/tutorials/) - Grafana Tutorials are step-by-step guides that help you make the most of Grafana
- [Grafana UI Library](https://developers.grafana.com/ui) - UI components to help you build interfaces using Grafana Design System
- [Grafana plugin SDK for Go](https://grafana.com/docs/grafana/latest/developers/plugins/backend/grafana-plugin-sdk-for-go/)