Plugins 〉Guided Tour
Guided Tour
Guided tour panel for grafana dashboards
Add guided tour to your Grafana dashboards.
Disclaimer: This plugin is an EXPERIMENTAL plugin. Only tested against selected versions of grafana and specific use cases.
Features
- Add guided steps targeting dashboard panels
- Customize the tour controller with custom markdown
- Customize tour color theme and style
- Support for grafana dark and light mode
- Does support markdown content
- Option to auto start the tour on dashboard load
- Option to redirect to different dashboard at the end of the tour
Setup
- Add Guided Tour Panel to your dashboard like any other panel.
- Add as many steps required. Provide exact panel title for the step and then specify content. Content can be in markdown format.
- Customize the look and feel if required.
Known limitations
- Panels you are navigating should be in viewport
- Panels collapsed inside dashboard rows can't be targeted
- Guided tour panel controller needs to be at the top of the dashboard or at least it should be in viewport
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Installing Guided Tour on Grafana Cloud:
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
For more information, visit the docs on plugin installation.
Installing on a local Grafana:
For local instances, plugins are installed and updated via a simple CLI command. Plugins are not updated automatically, however you will be notified when updates are available right within your Grafana.
1. Install the Panel
Use the grafana-cli tool to install Guided Tour from the commandline:
grafana-cli plugins install The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins. More information on the cli tool.
Alternatively, you can manually download the .zip file for your architecture below and unpack it into your grafana plugins directory.
Alternatively, you can manually download the .zip file and unpack it into your grafana plugins directory.
2. Add the Panel to a Dashboard
Installed panels are available immediately in the Dashboards section in your Grafana main menu, and can be added like any other core panel in Grafana.
To see a list of installed panels, click the Plugins item in the main menu. Both core panels and installed panels will appear.
Changelog
0.2.0 (2021-10-07)
- BREAKING: Plugin ID renamed from
yesoreyeram-guidedtour-paneltografana-guidedtour-panel - BREAKING: Grafana dependency updated to
>=8.1.0
0.1.0 (2021-07-12)
- Signed version of the plugin released
0.0.4 (2021-07-02)
- Feature: Support for customizing floater width
- Bug fix: Fix missing colors
0.0.3 (2021-07-02)
- Feature: Support for re-ordering steps
- Experimental: Background image support for tour popups
0.0.2 (2021-07-02)
- Feature: Support for customizing controller UI and content
- Feature: Support for scrollOffset added
- Feature: Support for customizing tour control
- Feature: Support for customizing beacon position
- Bug fix: Fixed a bug where finish cause redirection when closed the tour
0.0.1 (2021-07-01)
Initial release.
