6a351959d2
* Move data source management to administration
* Move RBAC to administration
* Move team management up a docs org level
* Combine and rename admin preferences docs
* Move plugin management to administration
* Combine plugin management docs
* Combine API key docs
* Combine service account docs
* Combine server user management docs
* Move datasource management to administration
* Move enterprise licenses to administration
* Move CLI out of admin, update links to admin
* Merge org user management docs
* Restructure to Torkel's plan
* Fix typo
* Weigh admin topics for navigation
* Weigh administration topics and align to Torkel's plan
* Move server user management from server admin to admin/user management
* Move configure docker image to setup guide
* Move the remaining server admin docs to the root admin directory
* Reweight docker config
Backport of 845cebdee2 from main
3.1 KiB
aliases, title, weight
| aliases | title | weight | ||
|---|---|---|---|---|
|
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 Toolkit.
Open the terminal, and run the following command in your [plugin directory]({{< relref "../../setup-grafana/configure-grafana/#plugins" >}}):
npx @grafana/toolkit plugin:create my-grafana-plugin
Note: If running NPM 7+ the
npxcommands mentioned in this article may hang. The workaround is to usenpx --legacy-peer-deps <command to run>.
If you want a more guided introduction to plugin development, check out our tutorials:
- [Build a panel plugin]({{< ref "/tutorials/build-a-panel-plugin/" >}})
- [Build a data source plugin]({{< ref "/tutorials/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]({{< ref "/tutorials/build-a-panel-plugin/" >}})
- [Build a data source plugin]({{< ref "/tutorials/build-a-data-source-plugin/" >}})
- [Build a data source backend plugin]({{< ref "/tutorials/build-a-data-source-backend-plugin/" >}})
Ready to learn more? Check out our other tutorials:
- [Build a panel plugin with D3.js]({{< ref "/tutorials/build-a-panel-plugin-with-d3/" >}})
Guides
Improve an existing plugin with one of our guides:
- [Add authentication for data source plugins]({{< relref "add-authentication-for-data-source-plugins/" >}})
- [Add support for annotations]({{< relref "add-support-for-annotations/" >}})
- [Add support for Explore queries]({{< relref "add-support-for-explore-queries/" >}})
- [Add support for variables]({{< relref "add-support-for-variables/" >}})
- [Add a query editor help component]({{< relref "add-query-editor-help/" >}})
- [Build a logs data source plugin]({{< relref "build-a-logs-data-source-plugin/" >}})
- [Build a streaming data source plugin]({{< relref "build-a-streaming-data-source-plugin/" >}})
- [Error handling]({{< relref "error-handling/" >}})
- [Working with data frames]({{< relref "working-with-data-frames/" >}})
- [Development with local Grafana]({{< relref "development-with-local-grafana/" >}})
Concepts
Deepen your knowledge through a series of high-level overviews of plugin concepts:
- [Data frames]({{< relref "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]({{< relref "metadata/" >}})
Typescript
- Grafana Data
- Grafana Runtime
- Grafana UI
Go
- [Grafana Plugin SDK for Go]({{< relref "backend/grafana-plugin-sdk-for-go/" >}})