Section 1 · Introduction

What's a plugin, and what you can add with it

Estimated time: 2 min

What’s a Grafana plugin, and what can you do with it?

A plugin is a folder of code that Grafana loads when it starts. Grafana reads it, registers what the code provides, and runs it so the new capability appears in the interface next to the built-in ones.

For example, a data source you write is usable in dashboards and Explore. A visualization you write is selectable as a panel on a dashboard.

Match your goal to one of the three plugin types

With the create-plugin tool, you can build one of these three things that Grafana can’t do today:

  • A new way to draw data: When no built-in visualization shows your data the way you need it, you can add one that appears in the normal panel list. To do this, use a panel plugin.
  • Access to a system Grafana can’t query yet: If it’s a database, an API, or another source Grafana can’t query yet, you can add it and then use it in dashboards and Explore, and in alert rules if the plugin has a backend component. To do this, use a data source plugin.
  • A complete experience: Custom pages, and optionally the dashboards and data sources that go with them, in one package. To do this, use an app plugin.

The tool also offers App with Scenes, an app plugin whose pages are built as dynamic, dashboard-like experiences. Refer to the Grafana Scenes documentation to learn more.