Managing playlists
This documentation topic is designed for Grafana workspaces that support Grafana version 9.x.
For Grafana workspaces that support Grafana version 10.x, see Working in Grafana version 10.
For Grafana workspaces that support Grafana version 8.x, see Working in Grafana version 8.
A playlist is a list of dashboards that are displayed in a sequence. You might use a playlist to build situational awareness or to present your metrics to your team or visitors. Grafana automatically scales dashboards to any resolution, which makes them perfect for large screens. You can access the playlist feature from Grafana’s side menu in the Dashboards submenu.
Accessing, sharing, and controlling a playlist
Use the information in this section to access existing playlists. Start and control the display of a playlist using one of the five available modes.
Accessing a playlist
-
Hover your cursor over Grafana’s side menu.
-
Click Playlists.
You will see a list of existing playlists.
Starting a playlist
You can start a playlist in five different view modes. View mode determines how the menus and navigation bar appear on the dashboards.
By default, each dashboard is displayed for the amount of time entered in the Interval field, which you set when you create or edit a playlist. After you start a playlist, you can control it with the navigation bar at the top of the page.
The playlist displays each dashboard for the time specified in the
Interval
field, set when creating or editing a playlist. After a
playlist starts, you can control it using the navigation bar at the top of your
screen.
-
Access the playlist page to see a list of existing playlist.
-
Find the playlist that you want to start, then click Start playlist.
The start playlist dialog box will open.
-
Select one of the five playlist modes available based on the information in the following table.
-
Click Start.
Mode | Description |
---|---|
Normal mode |
|
TV mode |
|
TV mode (with auto fit panels) |
|
Kiosk mode |
|
Kiosk mode (with auto fit panels) |
|
Controlling a playlist
You can control a playlist in Normal or TV mode after it has started, using the navigation bar at
the top of your screen. Press the Esc
key in your keyboard to stop the
playlist.
Button | Action |
---|---|
Next (double-right arrow) |
Advances to the next dashboard. |
Back (left arrow) |
Returns to the previous dashboard. |
Stop (square) |
Ends the playlist, and exits to the current dashboard. |
Cycle view mode (monitor icon) |
Rotates the display of the dashboards in different view modes. |
Time range |
Displays data within a time range. It can be set to display the last 5 minutes up to 5 years ago, or a custom time range, using the down arrow. |
Refresh (circle arrow) |
Reloads the dashboard, to display the current data. It can be set to reload automatically every 5 seconds to 1 day, using the dropdown arrow. |
Creating a playlist
You can create a playlist to present dashboards in a sequence with a set order and time interval between dashboards.
-
Click New playlist on the playlist page.
-
Enter a descriptive name in the Name text box.
-
Enter a time interval in the Interval text box.
Note
The dashboards you add are listed in a sequential order.
-
In Dashboards, add existing dashboards to the playlist using the Add by title and Add by tag dropdown options.
-
Optionally:
-
Search for a dashboard by its name, a regular expression, or a tag.
-
Filter your results by starred status or tags.
-
Rearrange the order of the dashboard you have added using the up and down arrow icon.
-
Remove a dashboard from the playlist by clicking the X icon beside dashboard.
-
-
Click Save to save your changes.
Saving a playlist
You can save a playlist and add it to your Playlists page, where you can start it.
Important
Ensure all the dashboards that you want to appear in your playlist are added when creating or editing the playlist before saving it.
-
To access the playlist feature, hover your cursor over Grafana’s side menu.
-
Click Playlists to view the playlists available to you.
-
Click on the playlist of your choice.
-
Edit the playlist.
-
Check that the playlist has a Name, Interval, and at least one Dashboard added to it.
-
Click Save to save your changes.
Editing or deleting a playlist
You can edit a playlist by updating its name, interval time, and by adding, removing, and rearranging the order of dashboards.
Editing a playlist
-
Click Edit playlist on the playlist page.
-
Update the name and time interval, then add or remove dashboards from the playlist using instructions in Create a playlist, above.
-
Click Save to save your changes.
Deleting a playlist
-
Click Playlists.
-
Click Remove next to the playlist you want to delete.
Rearranging dashboard order
-
Next to the dashboard you want to move, click the up or down arrow.
-
Click Save to save your changes.
Removing a dashboard
-
Click Remove to remove a dashboard from the playlist.
-
Click Save to save your changes.
Sharing a playlist in view mode
You can share a playlist by copying the link address on the view mode you prefer, and pasting the URL to your destination.
-
From the Dashboards submenu, click Playlists.
-
Click Start playlist next to the playlist you want to share.
-
In the dropdown, right click the view mode you prefer.
-
Click Copy Link Address to copy the URL to your clipboard.
-
Paste the URL to your destination.