The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
grafana/docs/sources/developers/plugins/_index.md

2.9 KiB

aliases description title weight
[../plugins/developing/] Resources for creating Grafana plugins Build a plugin 200

Build a plugin

For more information on the types of plugins you can build, refer to the [Plugin Overview]({{< relref "../../administration/plugin-management/" >}}).

Get started

The easiest way to start developing Grafana plugins is to use the Grafana create-plugin tool.

Open the terminal, and run the following command in your [plugin directory]({{< relref "../../setup-grafana/configure-grafana/#plugins" >}}):

npx @grafana/create-plugin@latest

Follow the questions and you will have a starter plugin ready to develop.

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

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:

Ready to learn more? Check out our other tutorials:

Guides

Improve an existing plugin with one of our guides:

  • [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" >}})

Concepts

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

  • [Data frames]({{< relref "data-frames.md" >}})

UI library

Explore the many UI components in our Grafana UI library.

Examples

For inspiration, check out our plugin examples.

Metadata

  • [Plugin metadata]({{< relref "metadata.md" >}})

SDK

  • [Grafana Plugin SDK for Go]({{< relref "backend/grafana-plugin-sdk-for-go.md" >}})