README.md

Grafana Plugin SDK for Go

This SDK enables building Grafana backend plugins using Go.

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. In particular, you can find the following packages:

• backend: Package backend provides SDK handler interfaces and contracts for implementing and serving backend plugins. It includes multiple sub-packages.
• build: Package build includes standard mage targets useful when building plugins.
• data: Package data provides data structures that Grafana recognizes. It includes multiple subpackages like converters, framestruct and sqlutil.
• experimental: Package experimental provides multiple experimental features. It includes multiple sub-packages.
• live: Package live provides types for the Grafana Live server.

See the list of all packages here.

Contributing

If you're interested in contributing to this project:

• Start by reading the Contributing guide.
• Learn how to set up your local environment, in our Developer guide.

License

Apache 2.0 License