grafana/docs/sources/administration/plugin-management/_index.md

130 lines
5.8 KiB
Markdown
Raw Permalink Normal View History

---
aliases:
- ../plugins/
- ../plugins/catalog/
- ../plugins/installation/
- ../plugins/plugin-signature-verification/
- ../plugins/plugin-signatures/
Explicitly set all front matter labels in the source files (#71548) * Set every page to have defaults of 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/enterprise-licensing pages to have 'Enterprise' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/recorded-queries pages to have labels cloud,enterprise * Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/stats-and-license pages to have labels cloud,enterprise * Set alerting pages to have labels cloud,enterprise,oss * Set breaking-changes pages to have labels cloud,enterprise,oss * Set dashboards pages to have labels cloud,enterprise,oss * Set datasources pages to have labels cloud,enterprise,oss * Set explore pages to have labels cloud,enterprise,oss * Set fundamentals pages to have labels cloud,enterprise,oss * Set introduction/grafana-cloud pages to have labels cloud Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix introduction pages products Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set panels-visualizations pages to have labels cloud,enterprise,oss * Set release-notes pages to have labels cloud,enterprise,oss * Set search pages to have labels cloud,enterprise,oss * Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss * Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise * Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise * Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise * Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set troubleshooting pages to have labels cloud,enterprise,oss * Set whatsnew pages to have labels cloud,enterprise,oss * Apply updated labels from review Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 16:10:12 +08:00
labels:
products:
- enterprise
Docs/usman plugin mgmt (#85424) * fixed text and better formatting * added examples of community and partners plugins * added more clarity to apps plugin usage * added and also fixed more * added clarity to the server and org admin roles * run prettier * fixed some minor typos * Apply suggestions from code review thanks. looks good now- Co-authored-by: David Harris <david.harris@grafana.com> * Technical edit * restorted the changes in panel and datasource examples as requested * revert duplicated change * Apply suggestions from code review Thanks Jack for the suggestions. Looks good!! Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * added minor adjustment * fixed typo * added bash syntax * revert changes * added changes from PR 87168 for index.md file * Delete docs/sources/shared/find-and-use-plugins.md removed this file from the PR as was not intended to be part of this PR. This PR is only for the Grafana OSS and not for the Grafana Cloud * run prettier * Apply suggestions from code review Co-authored-by: David Harris <david.harris@grafana.com> * Update docs/sources/administration/plugin-management/index.md Co-authored-by: David Harris <david.harris@grafana.com> * Update docs/sources/administration/plugin-management/index.md Co-authored-by: David Harris <david.harris@grafana.com> * added a small text fix * added cloud tag in product labels * run prettier * Apply suggestions from code review thanks for the review Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com> * fixed typo for note section * run prettier to fix --------- Co-authored-by: David Harris <david.harris@grafana.com> Co-authored-by: Joe Perez <joseph.perez@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>
2024-05-21 16:24:26 +08:00
- cloud
Explicitly set all front matter labels in the source files (#71548) * Set every page to have defaults of 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/enterprise-licensing pages to have 'Enterprise' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/recorded-queries pages to have labels cloud,enterprise * Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/stats-and-license pages to have labels cloud,enterprise * Set alerting pages to have labels cloud,enterprise,oss * Set breaking-changes pages to have labels cloud,enterprise,oss * Set dashboards pages to have labels cloud,enterprise,oss * Set datasources pages to have labels cloud,enterprise,oss * Set explore pages to have labels cloud,enterprise,oss * Set fundamentals pages to have labels cloud,enterprise,oss * Set introduction/grafana-cloud pages to have labels cloud Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix introduction pages products Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set panels-visualizations pages to have labels cloud,enterprise,oss * Set release-notes pages to have labels cloud,enterprise,oss * Set search pages to have labels cloud,enterprise,oss * Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss * Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise * Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise * Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise * Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set troubleshooting pages to have labels cloud,enterprise,oss * Set whatsnew pages to have labels cloud,enterprise,oss * Apply updated labels from review Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 16:10:12 +08:00
- oss
title: Plugin management
weight: 600
---
# Plugin management
Plugins enhance your Grafana experience with new ways to connect to and visualize data.
Read on for an overview on how to get started with plugins:
- Plugins are available in the [plugin catalog](#plugin-catalog). They can be built by Grafana Labs, commercial partners, our community, or you can [build a plugin yourself](/developers/plugin-tools).
- There are three [types of plugins](#types-of-plugins): panel, data source, and app plugins.
- Learn [how to install](#install-a-plugin), [update](#update-a-plugin) and [verify](#verify-your-plugins) your plugins.
Docs/usman plugin mgmt (#85424) * fixed text and better formatting * added examples of community and partners plugins * added more clarity to apps plugin usage * added and also fixed more * added clarity to the server and org admin roles * run prettier * fixed some minor typos * Apply suggestions from code review thanks. looks good now- Co-authored-by: David Harris <david.harris@grafana.com> * Technical edit * restorted the changes in panel and datasource examples as requested * revert duplicated change * Apply suggestions from code review Thanks Jack for the suggestions. Looks good!! Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * added minor adjustment * fixed typo * added bash syntax * revert changes * added changes from PR 87168 for index.md file * Delete docs/sources/shared/find-and-use-plugins.md removed this file from the PR as was not intended to be part of this PR. This PR is only for the Grafana OSS and not for the Grafana Cloud * run prettier * Apply suggestions from code review Co-authored-by: David Harris <david.harris@grafana.com> * Update docs/sources/administration/plugin-management/index.md Co-authored-by: David Harris <david.harris@grafana.com> * Update docs/sources/administration/plugin-management/index.md Co-authored-by: David Harris <david.harris@grafana.com> * added a small text fix * added cloud tag in product labels * run prettier * Apply suggestions from code review thanks for the review Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com> * fixed typo for note section * run prettier to fix --------- Co-authored-by: David Harris <david.harris@grafana.com> Co-authored-by: Joe Perez <joseph.perez@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>
2024-05-21 16:24:26 +08:00
[Advanced options](#advanced-options) allow you to:
- Customize where app plugin pages appear in the navigation menu.
- Configure backend communication between installed plugins.
- Improve security by isolating plugins with the Plugin Frontend Sandbox.
## Types of plugins
Grafana supports three types of plugins:
- [Panels](/grafana/plugins/panel-plugins) - These plugins make it easy to create and add any kind of visualization, to show your data, or improve your favorite dashboards.
- [Data sources](/grafana/plugins/data-source-plugins) - 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](/grafana/plugins/app-plugins) - These plugins enable the bundling of data sources, panels, dashboards, and Grafana pages into a cohesive experience.
Read more in [Types of plugins](plugin-types).
## 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](../roles-and-permissions/).
Docs/usman plugin mgmt (#85424) * fixed text and better formatting * added examples of community and partners plugins * added more clarity to apps plugin usage * added and also fixed more * added clarity to the server and org admin roles * run prettier * fixed some minor typos * Apply suggestions from code review thanks. looks good now- Co-authored-by: David Harris <david.harris@grafana.com> * Technical edit * restorted the changes in panel and datasource examples as requested * revert duplicated change * Apply suggestions from code review Thanks Jack for the suggestions. Looks good!! Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * added minor adjustment * fixed typo * added bash syntax * revert changes * added changes from PR 87168 for index.md file * Delete docs/sources/shared/find-and-use-plugins.md removed this file from the PR as was not intended to be part of this PR. This PR is only for the Grafana OSS and not for the Grafana Cloud * run prettier * Apply suggestions from code review Co-authored-by: David Harris <david.harris@grafana.com> * Update docs/sources/administration/plugin-management/index.md Co-authored-by: David Harris <david.harris@grafana.com> * Update docs/sources/administration/plugin-management/index.md Co-authored-by: David Harris <david.harris@grafana.com> * added a small text fix * added cloud tag in product labels * run prettier * Apply suggestions from code review thanks for the review Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com> * fixed typo for note section * run prettier to fix --------- Co-authored-by: David Harris <david.harris@grafana.com> Co-authored-by: Joe Perez <joseph.perez@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>
2024-05-21 16:24:26 +08:00
The following access rules apply depending on the user role:
Docs/usman plugin mgmt (#85424) * fixed text and better formatting * added examples of community and partners plugins * added more clarity to apps plugin usage * added and also fixed more * added clarity to the server and org admin roles * run prettier * fixed some minor typos * Apply suggestions from code review thanks. looks good now- Co-authored-by: David Harris <david.harris@grafana.com> * Technical edit * restorted the changes in panel and datasource examples as requested * revert duplicated change * Apply suggestions from code review Thanks Jack for the suggestions. Looks good!! Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * added minor adjustment * fixed typo * added bash syntax * revert changes * added changes from PR 87168 for index.md file * Delete docs/sources/shared/find-and-use-plugins.md removed this file from the PR as was not intended to be part of this PR. This PR is only for the Grafana OSS and not for the Grafana Cloud * run prettier * Apply suggestions from code review Co-authored-by: David Harris <david.harris@grafana.com> * Update docs/sources/administration/plugin-management/index.md Co-authored-by: David Harris <david.harris@grafana.com> * Update docs/sources/administration/plugin-management/index.md Co-authored-by: David Harris <david.harris@grafana.com> * added a small text fix * added cloud tag in product labels * run prettier * Apply suggestions from code review thanks for the review Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com> * fixed typo for note section * run prettier to fix --------- Co-authored-by: David Harris <david.harris@grafana.com> Co-authored-by: Joe Perez <joseph.perez@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>
2024-05-21 16:24:26 +08:00
- 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.
### Browse plugins
To browse for available plugins:
Docs/usman plugin mgmt (#85424) * fixed text and better formatting * added examples of community and partners plugins * added more clarity to apps plugin usage * added and also fixed more * added clarity to the server and org admin roles * run prettier * fixed some minor typos * Apply suggestions from code review thanks. looks good now- Co-authored-by: David Harris <david.harris@grafana.com> * Technical edit * restorted the changes in panel and datasource examples as requested * revert duplicated change * Apply suggestions from code review Thanks Jack for the suggestions. Looks good!! Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * added minor adjustment * fixed typo * added bash syntax * revert changes * added changes from PR 87168 for index.md file * Delete docs/sources/shared/find-and-use-plugins.md removed this file from the PR as was not intended to be part of this PR. This PR is only for the Grafana OSS and not for the Grafana Cloud * run prettier * Apply suggestions from code review Co-authored-by: David Harris <david.harris@grafana.com> * Update docs/sources/administration/plugin-management/index.md Co-authored-by: David Harris <david.harris@grafana.com> * Update docs/sources/administration/plugin-management/index.md Co-authored-by: David Harris <david.harris@grafana.com> * added a small text fix * added cloud tag in product labels * run prettier * Apply suggestions from code review thanks for the review Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com> * fixed typo for note section * run prettier to fix --------- Co-authored-by: David Harris <david.harris@grafana.com> Co-authored-by: Joe Perez <joseph.perez@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>
2024-05-21 16:24:26 +08:00
1. While logged into Grafana as an administrator, click **Administration > Plugins and data > Plugins** in the side menu to view installed and available plugins.
1. Use the search box to filter based on name, keywords, organization and other metadata.
1. Click the **Data sources**, **Panels**, or **Applications** buttons to filter by plugin type.
## Manage your plugins
2025-08-14 22:11:52 +08:00
We strongly recommend running the latest plugin version. Use [Grafana Advisor](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/administration/grafana-advisor) to check the status of your data sources and plugins.
### Install a plugin
The most common way to install a plugin is through the Grafana UI.
Docs/usman plugin mgmt (#85424) * fixed text and better formatting * added examples of community and partners plugins * added more clarity to apps plugin usage * added and also fixed more * added clarity to the server and org admin roles * run prettier * fixed some minor typos * Apply suggestions from code review thanks. looks good now- Co-authored-by: David Harris <david.harris@grafana.com> * Technical edit * restorted the changes in panel and datasource examples as requested * revert duplicated change * Apply suggestions from code review Thanks Jack for the suggestions. Looks good!! Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * added minor adjustment * fixed typo * added bash syntax * revert changes * added changes from PR 87168 for index.md file * Delete docs/sources/shared/find-and-use-plugins.md removed this file from the PR as was not intended to be part of this PR. This PR is only for the Grafana OSS and not for the Grafana Cloud * run prettier * Apply suggestions from code review Co-authored-by: David Harris <david.harris@grafana.com> * Update docs/sources/administration/plugin-management/index.md Co-authored-by: David Harris <david.harris@grafana.com> * Update docs/sources/administration/plugin-management/index.md Co-authored-by: David Harris <david.harris@grafana.com> * added a small text fix * added cloud tag in product labels * run prettier * Apply suggestions from code review thanks for the review Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com> * fixed typo for note section * run prettier to fix --------- Co-authored-by: David Harris <david.harris@grafana.com> Co-authored-by: Joe Perez <joseph.perez@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>
2024-05-21 16:24:26 +08:00
1. In Grafana, click **Administration > Plugins and data > Plugins** in the side navigation menu to view all plugins.
1. Browse and find a plugin.
Docs/usman plugin mgmt (#85424) * fixed text and better formatting * added examples of community and partners plugins * added more clarity to apps plugin usage * added and also fixed more * added clarity to the server and org admin roles * run prettier * fixed some minor typos * Apply suggestions from code review thanks. looks good now- Co-authored-by: David Harris <david.harris@grafana.com> * Technical edit * restorted the changes in panel and datasource examples as requested * revert duplicated change * Apply suggestions from code review Thanks Jack for the suggestions. Looks good!! Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * added minor adjustment * fixed typo * added bash syntax * revert changes * added changes from PR 87168 for index.md file * Delete docs/sources/shared/find-and-use-plugins.md removed this file from the PR as was not intended to be part of this PR. This PR is only for the Grafana OSS and not for the Grafana Cloud * run prettier * Apply suggestions from code review Co-authored-by: David Harris <david.harris@grafana.com> * Update docs/sources/administration/plugin-management/index.md Co-authored-by: David Harris <david.harris@grafana.com> * Update docs/sources/administration/plugin-management/index.md Co-authored-by: David Harris <david.harris@grafana.com> * added a small text fix * added cloud tag in product labels * run prettier * Apply suggestions from code review thanks for the review Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com> * fixed typo for note section * run prettier to fix --------- Co-authored-by: David Harris <david.harris@grafana.com> Co-authored-by: Joe Perez <joseph.perez@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com>
2024-05-21 16:24:26 +08:00
1. Click the plugin's logo.
1. Click **Install**.
{{< admonition type="note" >}}
To see additional ways to install plugins refer to [Install a plugin](plugin-install).
{{< /admonition >}}
### 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.
1. Click the **Installed** filter to show only installed plugins.
1. Click the plugin's logo.
1. 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.
1. Click the plugin's logo.
1. Click the **Installed** filter to show only installed plugins.
1. Click **Uninstall**.
When the update is complete, a confirmation message will indicate the installation was successful.
### Verify your plugins
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. Read more in [Plugin signatures](plugin-sign).
## Advanced options
### Customize navigation placement of plugin pages
You can relocate app plugin pages to customize the navigation menu structure, as explained in [Customize navigation placement of plugin pages](customize-nav-bar).
### Allow plugin backend communication
You can configure your Grafana instance to let the frontends of installed plugins directly communicate locally with the backends of other installed plugins. See how in [Configure backend communication between installed plugins](plugin-integrate).
### Isolate plugin code with the Frontend Sandbox
You can use the [Plugin Frontend Sandbox](plugin-frontend-sandbox) to securely isolate plugin frontend code from the main Grafana application.
When enabled, plugins run in a separate JavaScript context, which provides several security benefits:
- Prevents plugins from modifying parts of the Grafana interface outside their designated areas
- Stops plugins from interfering with other plugins functionality
- Protects core Grafana features from being altered by plugins
- Prevents plugins from modifying global browser objects and behaviors
### Learn more
- [Browse available plugins](/grafana/plugins)
- [Develop your own plugins](/developers/plugin-tools)
- [Reach out to the plugin development Community](https://community.grafana.com/c/plugin-development/30)