Documentation Grafana documentation Administration Plugin management

Plugin management

You can enhance your Grafana experience with plugins, extensions to Grafana beyond the wide range of visualizations and data sources that are built-in.

This guide shows you how to install plugins that are built by Grafana Labs, commercial partners, our community, or plugins that you have built yourself.

Types of plugins

Grafana supports three types of plugins:

• Panels - These plugins make it easy to create and add any kind of panel, to show your data, or improve your favorite dashboards.
• Data sources - These plugins allow you to pull data from various data sources such as databases, APIs, log files, and so on, and display it in the form of graphs, charts, and dashboards in Grafana.
• Apps - These plugins enable the bundling of data sources, panels, dashboards, and Grafana pages into a cohesive experience.

Panel plugins

Add new visualizations to your dashboard with panel plugins, such as the Clock, Mosaic and Variable panels.

Use panel plugins when you want to:

• Visualize data returned by data source queries.
• Navigate between dashboards.
• Control external systems, such as smart home devices.

Data source plugins

Data source plugins add support for new databases, such as Google BigQuery.

Data source plugins communicate with external sources of data and return the data in a format that Grafana understands. By adding a data source plugin, you can immediately use the data in any of your existing dashboards.

Use data source plugins when you want to query data from external or third-party systems.

App plugins

Applications, or app plugins, bundle data sources and panels to provide a cohesive experience, such as the Zabbix app.

Apps can also add custom pages for things like control panels.

Use app plugins when you want an out-of-the-box monitoring experience.

Managing access for app plugins

Customize access to app plugins with RBAC.

By default, the Viewer, Editor and Admin roles have access to all app plugins that their Organization role allows them to access. Access is granted by the fixed:plugins.app:reader role.

Plugin catalog

The Grafana plugin catalog allows you to browse and manage plugins from within Grafana. Only Grafana server administrators and Organization administrators can access and use the plugin catalog. For more information about Grafana roles and permissions, refer to Roles and permissions.

The following access rules apply depending on the user role:

• If you are an Org Admin, you can configure app plugins, but you can’t install, uninstall, or update them.
• If you are a Server Admin, you can’t configure app plugins, but you can install, uninstall, or update them.
• If you are both Org Admin and Server Admin, you can configure app plugins and also install, uninstall, or update them.

Video shows the Plugin catalog in a previous version of Grafana.

Browse plugins

To browse for available plugins:

1. While logged into Grafana as an administrator, click Administration > Plugins and data > Plugins in the side menu to view installed and available plugins.
2. Use the search to filter based on name, keywords, organization and other metadata.
3. Click the Data sources, Panels, or Applications buttons to filter by plugin type.

Install a plugin

The most common way to install a plugin is through the Grafana UI, but alternative methods are also available.

1. In Grafana, click Administration > Plugins and data > Plugins in the side navigation menu to view all plugins.
2. Browse and find a plugin.
3. Click the plugin’s logo.
4. Click Install.

There are also additional ways to install plugins depending on your setup.

Install a plugin using Grafana CLI

Grafana CLI allows you to install, upgrade, and manage your Grafana plugins using a command line. For more information about Grafana CLI plugin commands, refer to Plugin commands.

Install a plugin from a ZIP file

This method is typically used for plugins not available in the Plugin Catalog or in environments without internet access.

Download the archive containing the plugin assets, and install it by extracting the archive into the plugin directory. For example:

bash Copy

unzip my-plugin-0.2.0.zip -d YOUR_PLUGIN_DIR/my-plugin

The path to the plugin directory is defined in the configuration file. For more information, refer to Configuration.

Install a plugin in air-gapped environment

Plugin installation usually requires an internet connection. You can check which endpoints are used during the installation on your instance and add them to your instance’s allowlist.

If this is not possible you can go via installing a plugin using Grafana CLI or as a ZIP file.

You can fetch any plugin from Grafana.com API following the download link referenced in the API. Here is an example based on grafana-lokiexplore-app plugins.

1. Open https://grafana.com/api/plugins/grafana-lokiexplore-app and look for links section
2. Find a download url which looks something like https://grafana.com/api/plugins/grafana-lokiexplore-app/versions/1.0.2/download
3. Use this URL to download the plugin ZIP file, which you can then install as described above.

Install plugins using the Grafana Helm chart

With the Grafana Helm chart, add the plugins you want to install as a list using the plugins field in the your values file. For more information about the configuration, refer to the Helm chart configuration reference.

The following YAML snippet installs v1.9.0 of the Grafana OnCall App plugin and the Redis data source plugin. You must incorporate this snippet within your Helm values file.

yaml Copy

plugins:
  - https://grafana.com/api/plugins/grafana-oncall-app/versions/v1.9.0/download;grafana-oncall-app
  - redis-datasource

When the update is complete, a confirmation message will indicate the installation was successful.

Update a plugin

To update a plugin:

1. In Grafana, click Administration > Plugins and data > Plugins in the side navigation menu to view all plugins.
2. Click the Installed filter to show only installed plugins.
3. Click the plugin’s logo.
4. Click Update.

When the update is complete, a confirmation message will indicate the installation was successful.

Uninstall a plugin

To uninstall a plugin:

1. In Grafana, click Administration > Plugins and data > Plugins in the side navigation menu to view all plugins.
2. Click the plugin’s logo.
3. Click the Installed filter to show only installed plugins.
4. Click Uninstall.

When the update is complete, a confirmation message will indicate the installation was successful.

Plugin signatures

Plugin signature verification, also known as signing, is a security measure to make sure plugins haven’t been tampered with. Upon loading, Grafana checks to see if a plugin is signed or unsigned when inspecting and verifying its digital signature.

At startup, Grafana verifies the signatures of every plugin in the plugin directory. If a plugin is unsigned, then Grafana neither loads nor starts it. To see the result of this verification for each plugin, navigate to Configuration -> Plugins.

Grafana also writes an error message to the server log:

bash Copy

WARN[05-26|12:00:00] Some plugin scanning errors were found   errors="plugin '<plugin id>' is unsigned, plugin '<plugin id>' has an invalid signature"

If you are a plugin developer and want to know how to sign your plugin, refer to Sign a plugin.

Plugin signature levels

All plugins are signed under a signature level. The signature level determines how the plugin can be distributed.

Allow unsigned plugins

We strongly recommend that you don’t run unsigned plugins in your Grafana instance. However, if you’re aware of the risks and you still want to load an unsigned plugin, refer to Configuration.

If you’ve allowed loading of an unsigned plugin, then Grafana writes a warning message to the server log:

bash Copy

WARN[06-01|16:45:59] Running an unsigned plugin   pluginID=<plugin id>

Learn more

• Browse plugins
• Develop plugins
• Plugin development Community