apitech
/
grafana
mirror of https://github.com/grafana/grafana
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
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.
25155 Commits
5978 Branches
596 Tags
1.7 GiB
 
 
 
 
 
 
Tag: Branch: Tree: 75de6165fc
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '75de6165fc'
${ noResults }
grafana/docs/sources/developers/plugins/_index.md

2.4 KiB
Raw Blame History

+++ title = "Build a plugin" type = "docs" +++

Build a plugin

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

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 "../../installation/configuration/_index.md#plugins" >}}):

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

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

  • [Build a panel plugin]({{< relref "../../../../../tutorials/build-a-panel-plugin.md" >}})
  • [Build a data source plugin]({{< relref "../../../../../tutorials/build-a-data-source-plugin.md" >}})

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]({{< relref "../../../../../tutorials/build-a-panel-plugin.md" >}})
  • [Build a data source plugin]({{< relref "../../../../../tutorials/build-a-data-source-plugin.md" >}})

Ready to learn more? Check out our other tutorials:

  • [Build a panel plugin with D3.js]({{< relref "../../../../../tutorials/build-a-panel-plugin-with-d3.md" >}})

Guides

Improve an existing plugin with one of our guides:

  • [Add support for annotations]({{< relref "add-support-for-annotations.md" >}})
  • [Add support for variables]({{< relref "add-support-for-variables.md" >}})
  • [Build a logs data source]({{< relref "build-a-logs-data-source.md" >}})

Concepts

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

  • [Data frames]({{< relref "data-frames.md" >}})
  • [Authentication for data source plugins]({{< relref "authentication.md" >}})

UI library

Explore the many UI components in our Grafana UI library.

API reference

Learn more about Grafana options and packages.

Metadata

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

Typescript

  • [Grafana Data]({{< relref "../../packages_api/data/_index.md" >}})
  • [Grafana Runtime]({{< relref "../../packages_api/runtime/_index.md" >}})
  • [Grafana UI]({{< relref "../../packages_api/ui/_index.md" >}})

Go