f9df1f3051
* Initial commit * Prettier fixes * Doc-validator fixes part 1 * Doc-validator fixes part 2 * More doc-validator fixes * More doc-validator fixes * Test * link test * Linnk test * Link test * More fixes * More fixes * Doc-validator fixes * Doc-validator fixes * fix broken link * Fix * Testing * Doc fixes * Link fixes * Fix links * Update docs/sources/developers/plugins/create-a-grafana-plugin/_index.md Co-authored-by: David Harris <david.harris@grafana.com> * Testing * Testing * Testing * Testing * Doc-validator fixes * Doc-validator fixes * Doc-validator fixes * Fix broken links for plugins reorganization project * Prettier fixes * Prettier fixes * Incorporate reviewer feedback * Link fixes * Link fixes * Link fixes * Link fix * Deleted space * Codeowners fix * Change grafana.com links to absolute URLs for Hugo --------- Co-authored-by: David Harris <david.harris@grafana.com>
3.3 KiB
| title | menuTitle | aliases | description | weight | |
|---|---|---|---|---|---|
| Grafana plugin developer's guide | Plugin developer's guide |
|
Resources for creating Grafana plugins | 200 |
Grafana plugin developer's guide
You can extend Grafana's built-in capabilities with plugins. Plugins enable Grafana to accomplish specialized tasks, custom-tailored to your requirements. By making a plugin for your organization, you can connect Grafana to other data sources, ticketing tools, and CI/CD tooling.
You can create plugins for private use or contribute them to the open source community by publishing to the Grafana plugin catalog. This catalog has hundreds of other community and commercial plugins.
If you are a Grafana plugin developer or want to become one, this plugin developer's guide contains the tutorials and reference materials to help you get started.
Plugin basics
You can create several types of plugins, including:
- Panel plugins - Visualize data and navigate between dashboards.
- Data source plugins - Link to new databases or other sources of data.
- App plugins - Create rich applications for custom out-of-the-box experiences.
Note: To learn more about the types of plugins you can build, refer to the [Plugin management]({{< relref "../../administration/plugin-management" >}}) documentation.
Contents of this developer's guide
The following topics are covered in this guide:
- [Introduction to plugin development]({{< relref "./introduction-to-plugin-development" >}}) - Learn the fundamentals of Grafana plugin development: backend development, data frames, error handling, and more.
- [Get started with plugins]({{< relref "./get-started-with-plugins" >}}) - Start developing Grafana plugins with the create-plugin tool.
- [Create a Grafana plugin]({{< relref "./create-a-grafana-plugin/_index.md" >}}) - If you're familiar with plugin creation, use the tutorials for creating panel plugins, data source plugins, and more to deepen your knowledge.
- [Publish a Grafana plugin]({{< relref "./publish-a-plugin" >}}) - Learn about publishing a plugin to the Grafana plugin catalog, including publishing criteria, packaging, and deployment.
- [Work with legacy plugins]({{< relref "./legacy" >}}) - Learn how to upgrade from a previous version of a Grafana plugin, rewrite an old Angular plugin in React, or update to a newer version.
- [Migrate a plugin]({{< relref "./migration-guide" >}}) - Consult these documents if you need to work with a plugin written in deprecated technology.
- [Reference]({{< relref "./metadata.md" >}}) - Description of the
plugin.jsonschema and plugin metadata.
Go further
Learn more about additional tools and see plugin type examples.
User interface creation
Explore the many UI components in our Grafana UI library.
Plugin examples
Grafana Labs provides a number of best practice example plugins for different use cases to help you quickly get started. Browse our plugin examples.
SDK
Learn more about [Grafana Plugin SDK for Go]({{< relref "./introduction-to-plugin-development/backend/grafana-plugin-sdk-for-go" >}}).