https://github.com/grafana/grafana-plugin-sdk-go

A Go SDK for building backend plugins for Grafana
https://github.com/grafana/grafana-plugin-sdk-go

grafana grafana-plugin grafana-plugin-sdk sdk

Last synced: 7 days ago
JSON representation

A Go SDK for building backend plugins for Grafana

• Host: GitHub
• URL: https://github.com/grafana/grafana-plugin-sdk-go
• Owner: grafana
• License: apache-2.0
• Created: 2019-09-23T15:04:12.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-11-25T08:12:07.000Z (30 days ago)
• Last Synced: 2024-11-25T08:45:10.119Z (30 days ago)
• Topics: grafana, grafana-plugin, grafana-plugin-sdk, sdk
• Language: Go
• Size: 7.17 MB
• Stars: 219
• Watchers: 143
• Forks: 66
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Grafana Plugin SDK for Go

This SDK enables building [Grafana](https://github.com/grafana/grafana) backend plugins using Go.

[![License](https://img.shields.io/github/license/grafana/grafana-plugin-sdk-go)](LICENSE)

[![Go.dev](https://pkg.go.dev/badge/github.com/grafana/grafana-plugin-sdk-go)](https://pkg.go.dev/github.com/grafana/grafana-plugin-sdk-go?tab=doc)

[![Go Report Card](https://goreportcard.com/badge/github.com/grafana/grafana-plugin-sdk-go)](https://goreportcard.com/report/github.com/grafana/grafana-plugin-sdk-go)

[![CI Pipeline](https://github.com/grafana/grafana-plugin-sdk-go/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/grafana/grafana-plugin-sdk-go/actions/workflows/ci.yml?query=branch%3Amain)

## Current state

This SDK is still in development. The protocol between the Grafana server and the plugin SDK is considered stable, but we might introduce breaking changes in the SDK. This means that plugins using the older SDK should work with Grafana, but might lose out on new features and capabilities that we introduce in the SDK.

## Navigating the SDK

The SDK documentation can be navigated in the form of [Go docs](https://pkg.go.dev/github.com/grafana/grafana-plugin-sdk-go). In particular, you can find the following packages:

- [`backend`](https://pkg.go.dev/github.com/grafana/grafana-plugin-sdk-go/backend): Package `backend` provides SDK handler interfaces and contracts for implementing and serving backend plugins. It includes multiple sub-packages.

- [`build`](https://pkg.go.dev/github.com/grafana/grafana-plugin-sdk-go/build): Package `build` includes standard mage targets useful when building plugins.

- [`data`](https://pkg.go.dev/github.com/grafana/grafana-plugin-sdk-go/data): Package `data` provides data structures that Grafana recognizes. It includes multiple subpackages like `converters`, `framestruct` and `sqlutil`.

- [`experimental`](https://pkg.go.dev/github.com/grafana/grafana-plugin-sdk-go/experimental): Package `experimental` provides multiple experimental features. It includes multiple sub-packages.

- [`live`](https://pkg.go.dev/github.com/grafana/grafana-plugin-sdk-go/live): Package `live` provides types for the Grafana Live server.

See the list of all packages [here](https://pkg.go.dev/github.com/grafana/grafana-plugin-sdk-go#section-directories).

## Contributing

If you're interested in contributing to this project:

- Start by reading the [Contributing guide](/CONTRIBUTING.md).

- Learn how to set up your local environment, in our [Developer guide](/contribute/developer-guide.md).

## License

[Apache 2.0 License](https://github.com/grafana/grafana-plugin-sdk-go/blob/master/LICENSE)