Build a plugin

For more information on the types of plugins you can build, refer to the Plugin Overview.

Get started

The easiest way to start developing Grafana plugins is to use the Grafana Toolkit.

Open the terminal, and run the following command in your plugin directory:

npx @grafana/toolkit plugin:create my-grafana-plugin

Note: If running NPM 7+ the npx commands mentioned in this article may hang. The workaround is to use npx --legacy-peer-deps <command to run>.

If you want a more guided introduction to plugin development, check out our tutorials:

• Build a panel plugin
• Build a data source plugin

Go further

Learn more about specific areas of plugin development.

Tutorials

If you’re looking to build your first plugin, check out these introductory tutorials:

• Build a panel plugin
• Build a data source plugin
• Build a data source backend plugin

Ready to learn more? Check out our other tutorials:

• Build a panel plugin with D3.js

Guides

Improve an existing plugin with one of our guides:

• Add authentication for data source plugins
• Add support for annotations
• Add support for Explore queries
• Add support for variables
• Add a query editor help component
• Build a logs data source plugin
• Build a streaming data source plugin
• Error handling
• Working with data frames

Concepts

Deepen your knowledge through a series of high-level overviews of plugin concepts:

• Data frames

UI library

Explore the many UI components in our Grafana UI library.

Examples

For inspiration, check out our plugin examples.

API reference

Learn more about Grafana options and packages.

Metadata

• Plugin metadata

Typescript

• Grafana Data
• Grafana Runtime
• Grafana UI

Go

• Grafana Plugin SDK for Go