2022-05-26 10:06:25 -05:00
|
|
|
---
|
|
|
|
|
aliases:
|
2022-12-09 10:36:04 -06:00
|
|
|
- ../plugins/developing/
|
2022-07-08 14:21:29 -05:00
|
|
|
description: Resources for creating Grafana plugins
|
2022-12-09 10:36:04 -06:00
|
|
|
title: Build a plugin
|
2022-05-26 10:06:25 -05:00
|
|
|
weight: 200
|
|
|
|
|
---
|
2020-05-07 10:45:50 -05:00
|
|
|
|
|
|
|
|
# Build a plugin
|
|
|
|
|
|
2022-06-16 14:09:16 -05:00
|
|
|
For more information on the types of plugins you can build, refer to the [Plugin Overview]({{< relref "../../administration/plugin-management/" >}}).
|
2020-05-07 10:45:50 -05:00
|
|
|
|
|
|
|
|
## Get started
|
|
|
|
|
|
2022-11-09 08:15:23 -06:00
|
|
|
The easiest way to start developing Grafana plugins is to use the Grafana [create-plugin tool](https://www.npmjs.com/package/@grafana/create-plugin).
|
2020-05-07 10:45:50 -05:00
|
|
|
|
2022-06-02 11:57:22 -05:00
|
|
|
Open the terminal, and run the following command in your [plugin directory]({{< relref "../../setup-grafana/configure-grafana/#plugins" >}}):
|
2020-05-07 10:45:50 -05:00
|
|
|
|
|
|
|
|
```bash
|
2022-11-09 08:15:23 -06:00
|
|
|
npx @grafana/create-plugin
|
2020-05-07 10:45:50 -05:00
|
|
|
```
|
|
|
|
|
|
2022-11-09 08:15:23 -06:00
|
|
|
Follow the questions and you will have a starter plugin ready to develop.
|
2022-01-17 08:58:36 -06:00
|
|
|
|
2020-05-07 10:45:50 -05:00
|
|
|
If you want a more guided introduction to plugin development, check out our tutorials:
|
|
|
|
|
|
2023-01-30 06:48:12 -06:00
|
|
|
- [Build a panel plugin](/tutorials/build-a-panel-plugin/)
|
|
|
|
|
- [Build a data source plugin](/tutorials/build-a-data-source-plugin/)
|
2020-05-07 10:45:50 -05:00
|
|
|
|
|
|
|
|
## 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:
|
|
|
|
|
|
2023-01-30 06:48:12 -06:00
|
|
|
- [Build a panel plugin](/tutorials/build-a-panel-plugin/)
|
|
|
|
|
- [Build a data source plugin](/tutorials/build-a-data-source-plugin/)
|
|
|
|
|
- [Build a data source backend plugin](/tutorials/build-a-data-source-backend-plugin/)
|
2020-05-07 10:45:50 -05:00
|
|
|
|
|
|
|
|
Ready to learn more? Check out our other tutorials:
|
|
|
|
|
|
2023-01-30 06:48:12 -06:00
|
|
|
- [Build a panel plugin with D3.js](/tutorials/build-a-panel-plugin-with-d3/)
|
2020-05-07 10:45:50 -05:00
|
|
|
|
2020-05-12 16:31:36 -05:00
|
|
|
### Guides
|
|
|
|
|
|
|
|
|
|
Improve an existing plugin with one of our guides:
|
|
|
|
|
|
2023-02-07 05:01:44 -06:00
|
|
|
- [Add authentication for data source plugins]({{< relref "add-authentication-for-data-source-plugins.md" >}})
|
|
|
|
|
- [Add support for annotations]({{< relref "add-support-for-annotations.md" >}})
|
|
|
|
|
- [Add support for Explore queries]({{< relref "add-support-for-explore-queries.md" >}})
|
|
|
|
|
- [Add support for variables]({{< relref "add-support-for-variables.md" >}})
|
|
|
|
|
- [Add a query editor help component]({{< relref "add-query-editor-help.md" >}})
|
|
|
|
|
- [Build a logs data source plugin]({{< relref "build-a-logs-data-source-plugin.md" >}})
|
|
|
|
|
- [Build a streaming data source plugin]({{< relref "build-a-streaming-data-source-plugin.md" >}}/)
|
|
|
|
|
- [Error handling]({{< relref "error-handling.md" >}})
|
|
|
|
|
- [Working with data frames]({{< relref "working-with-data-frames.md" >}})
|
|
|
|
|
- [Development with local Grafana]({{< relref "development-with-local-grafana.md" >}})
|
2020-05-12 16:31:36 -05:00
|
|
|
|
|
|
|
|
### Concepts
|
|
|
|
|
|
|
|
|
|
Deepen your knowledge through a series of high-level overviews of plugin concepts:
|
|
|
|
|
|
2023-02-07 05:01:44 -06:00
|
|
|
- [Data frames]({{< relref "data-frames.md" >}})
|
2020-05-12 16:31:36 -05:00
|
|
|
|
|
|
|
|
### UI library
|
|
|
|
|
|
2023-02-07 05:01:44 -06:00
|
|
|
Explore the many UI components in our [Grafana UI library](https://developers.grafana.com/ui).
|
2020-05-12 16:31:36 -05:00
|
|
|
|
2020-09-25 09:47:52 -05:00
|
|
|
### Examples
|
|
|
|
|
|
2023-02-07 05:01:44 -06:00
|
|
|
For inspiration, check out our [plugin examples](https://github.com/grafana/grafana-plugin-examples).
|
2020-09-25 09:47:52 -05:00
|
|
|
|
2022-11-10 11:36:59 -06:00
|
|
|
### Metadata
|
2020-05-07 10:45:50 -05:00
|
|
|
|
2023-02-07 05:01:44 -06:00
|
|
|
- [Plugin metadata]({{< relref "metadata.md" >}})
|
2020-05-07 10:45:50 -05:00
|
|
|
|
2022-11-10 11:36:59 -06:00
|
|
|
### SDK
|
2020-05-07 10:45:50 -05:00
|
|
|
|
2023-02-07 05:01:44 -06:00
|
|
|
- [Grafana Plugin SDK for Go]({{< relref "backend/grafana-plugin-sdk-for-go.md" >}})
|
