Grafana Plugin Sdk Go banner
grafana grafana

Grafana Plugin Sdk Go

Development community

Description

A Go SDK for building backend plugins for Grafana

Installation

This entry records only its repository, not the path inside it, so there is no exact command to give. Open the source below and copy the folder into ~/.claude/skills/, or the file into ~/.claude/agents/.

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`: 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 `exp