mirror of
https://github.com/grafana/grafana.git
synced 2025-01-07 22:53:56 -06:00
7ef7cedc11
* Update dashboards pages to use `docs/reference` shortcode Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update panels-visualizations pages to use `docs/reference` shortcode Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Use raw Markdown admonitions for contextual links See https://discourse.gohugo.io/t/markdown-reference-links-in-shortcodes/5770/3. Should be resolved by https://docs.google.com/document/d/19xd4CD3IrAqQqNR3xQeLfuIV-u2iNSQSBEvPZE9J4qU/edit#heading=h.5sybau7waq2q. Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Prefer "Warning" over "Caution" Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * Prettier Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix some links missing destinations Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix 'time range controls' link Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Add missing 'HTTP APIs' link Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix dashboard links missing destinations Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix links missing destinations in panels and visualizations documentation Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix dud link Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
203 lines
8.3 KiB
Markdown
203 lines
8.3 KiB
Markdown
---
|
|
aliases:
|
|
- ../administration/reports/
|
|
- ../enterprise/export-pdf/
|
|
- ../enterprise/reporting/
|
|
- ../reference/share_dashboard/
|
|
- ../reference/share_panel/
|
|
- ../share-dashboards-panels/
|
|
- ../sharing/
|
|
- ../sharing/playlists/
|
|
- ../sharing/share-dashboard/
|
|
- ../sharing/share-panel/
|
|
- ./
|
|
- reporting/
|
|
- share-dashboard/
|
|
keywords:
|
|
- grafana
|
|
- dashboard
|
|
- documentation
|
|
- share
|
|
- panel
|
|
- library panel
|
|
- playlist
|
|
- reporting
|
|
- export
|
|
- pdf
|
|
labels:
|
|
products:
|
|
- cloud
|
|
- enterprise
|
|
- oss
|
|
menuTitle: Sharing
|
|
title: Share dashboards and panels
|
|
weight: 85
|
|
---
|
|
|
|
# Share dashboards and panels
|
|
|
|
Grafana enables you to share dashboards and panels with other users within an organization and in certain situations, publicly on the Web. You can share using:
|
|
|
|
- A direct link
|
|
- A Snapshot
|
|
- An embedded link (for panels only)
|
|
- An export link (for dashboards only)
|
|
|
|
You must have an authorized viewer permission to see an image rendered by a direct link.
|
|
|
|
The same permission is also required to view embedded links unless you have anonymous access permission enabled for your Grafana instance.
|
|
|
|
{{% admonition type="note" %}}
|
|
As of Grafana 8.0, anonymous access permission is not available in Grafana Cloud.
|
|
{{% /admonition %}}
|
|
|
|
When you share a panel or dashboard as a snapshot, a snapshot (which is a panel or dashboard at the moment you take the snapshot) is publicly available on the web. Anyone with a link to it can access it. Because snapshots do not require any authorization to view, Grafana removes information related to the account it came from, as well as any sensitive data from the snapshot.
|
|
|
|
## Share a dashboard
|
|
|
|
You can share a dashboard as a direct link or as a snapshot. You can also export a dashboard.
|
|
|
|
{{% admonition type="note" %}}
|
|
If you change a dashboard, ensure that you save the changes before sharing.
|
|
{{% /admonition %}}
|
|
|
|
1. Click **Dashboards** in the left-side menu.
|
|
1. Click the dashboard you want to share.
|
|
1. Click the share icon at the top of the screen.
|
|
|
|
The share dialog opens and shows the Link tab.
|
|
|
|
### Share a direct link
|
|
|
|
The **Link** tab shows the current time range, template variables, and the default theme. You can also share a shortened URL.
|
|
|
|
1. Click **Copy**.
|
|
|
|
This action copies the default or the shortened URL to the clipboard.
|
|
|
|
1. Send the copied URL to a Grafana user with authorization to view the link.
|
|
|
|
### Publish a snapshot
|
|
|
|
A dashboard snapshot shares an interactive dashboard publicly. Grafana strips sensitive data such as queries (metric, template and annotation) and panel links, leaving only the visible metric data and series names embedded in the dashboard. Dashboard snapshots can be accessed by anyone with the link.
|
|
|
|
You can publish snapshots to your local instance or to [snapshots.raintank.io](http://snapshots.raintank.io). The latter is a free service provided by Grafana Labs that enables you to publish dashboard snapshots to an external Grafana instance. Anyone with the link can view it. You can set an expiration time if you want the snapshot removed after a certain time period.
|
|
|
|
1. Click the **Snapshot** tab.
|
|
1. Click **Publish to snapshots.raintank.io** or **Local Snapshot**.
|
|
|
|
Grafana generates a link of the snapshot.
|
|
|
|
1. Copy the snapshot link, and share it either within your organization or publicly on the web.
|
|
|
|
If you created a snapshot by mistake, click **Delete snapshot** to remove the snapshot from your Grafana instance.
|
|
|
|
### Dashboard export
|
|
|
|
Grafana dashboards can easily be exported and imported. For more information, refer to [Export and import dashboards][].
|
|
|
|
## Export dashboard as PDF
|
|
|
|
You can generate and save PDF files of any dashboard.
|
|
|
|
> **Note:** Available in [Grafana Enterprise][] and [Grafana Cloud](/docs/grafana-cloud/).
|
|
|
|
1. Click **Dashboards** in the left-side menu.
|
|
1. Click the dashboard you want to share.
|
|
1. Click the share icon at the top of the screen.
|
|
1. On the PDF tab, select a layout option for the exported dashboard: **Portrait** or **Landscape**.
|
|
1. Click **Save as PDF** to render the dashboard as a PDF file.
|
|
|
|
Grafana opens the PDF file in a new window or browser tab.
|
|
|
|
## Share a panel
|
|
|
|
You can share a panel as a direct link, as a snapshot, or as an embedded link. You can also create library panels using the **Share** option on any panel.
|
|
|
|
1. Hover over any part of the panel to display the actions menu on the top right corner.
|
|
1. Click the menu and select **Share**.
|
|
|
|
The share dialog opens and shows the **Link** tab.
|
|
|
|
### Use direct link
|
|
|
|
The **Link** tab shows the current time range, template variables, and the default theme. You can optionally enable a shortened URL to share.
|
|
|
|
1. Click **Copy**.
|
|
|
|
This action copies the default or the shortened URL to the clipboard.
|
|
|
|
1. Send the copied URL to a Grafana user with authorization to view the link.
|
|
1. You also optionally click **Direct link rendered image** to share an image of the panel.
|
|
|
|
For more information, refer to [Image rendering][].
|
|
|
|
The following example shows a link to a server-side rendered PNG:
|
|
|
|
```bash
|
|
https://play.grafana.org/d/000000012/grafana-play-home?orgId=1&from=1568719680173&to=1568726880174&panelId=4&fullscreen
|
|
```
|
|
|
|
#### Query string parameters for server-side rendered images
|
|
|
|
- **width:** Width in pixels. Default is 800.
|
|
- **height:** Height in pixels. Default is 400.
|
|
- **tz:** Timezone in the format `UTC%2BHH%3AMM` where HH and MM are offset in hours and minutes after UTC
|
|
- **timeout:** Number of seconds. The timeout can be increased if the query for the panel needs more than the default 30 seconds.
|
|
- **scale:** Numeric value to configure device scale factor. Default is 1. Use a higher value to produce more detailed images (higher DPI). Supported in Grafana v7.0+.
|
|
|
|
### Publish a snapshot
|
|
|
|
A panel snapshot shares an interactive panel publicly. Grafana strips sensitive data leaving only the visible metric data and series names embedded in the dashboard. Panel snapshots can be accessed by anyone with the link.
|
|
|
|
You can publish snapshots to your local instance or to [snapshots.raintank.io](http://snapshots.raintank.io). The latter is a free service provided by [Grafana Labs](https://grafana.com), that enables you to publish dashboard snapshots to an external Grafana instance. You can optionally set an expiration time if you want the snapshot to be removed after a certain time period.
|
|
|
|
1. In the **Share Panel** dialog, click **Snapshot** to go to the tab.
|
|
1. Click **Publish to snapshots.raintank.io** or **Local Snapshot**.
|
|
|
|
Grafana generates the link of the snapshot.
|
|
|
|
1. Copy the snapshot link, and share it either within your organization or publicly on the web.
|
|
|
|
If you created a snapshot by mistake, click **Delete snapshot** to remove the snapshot from your Grafana instance.
|
|
|
|
### Embed panel
|
|
|
|
You can embed a panel using an iframe on another web site. A viewer must be signed into Grafana to view the graph.
|
|
|
|
**> Note:** As of Grafana 8.0, anonymous access permission is no longer available for Grafana Cloud.
|
|
|
|
Here is an example of the HTML code:
|
|
|
|
```html
|
|
<iframe
|
|
src="https://snapshots.raintank.io/dashboard-solo/snapshot/y7zwi2bZ7FcoTlB93WN7yWO4aMiz3pZb?from=1493369923321&to=1493377123321&panelId=4"
|
|
width="650"
|
|
height="300"
|
|
frameborder="0"
|
|
></iframe>
|
|
```
|
|
|
|
The result is an interactive Grafana graph embedded in an iframe.
|
|
|
|
### Library panel
|
|
|
|
To create a library panel from the **Share Panel** dialog:
|
|
|
|
1. Click **Library panel**.
|
|
1. In **Library panel name**, enter the name.
|
|
1. In **Save in folder**, select the folder in which to save the library panel. By default, the root level is selected.
|
|
1. Click **Create library panel** to save your changes.
|
|
1. Save the dashboard.
|
|
|
|
{{% docs/reference %}}
|
|
[Export and import dashboards]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/dashboards/manage-dashboards#export-and-import-dashboards"
|
|
[Export and import dashboards]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/dashboards/manage-dashboards#export-and-import-dashboards"
|
|
|
|
[Grafana Enterprise]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/introduction/grafana-enterprise"
|
|
[Grafana Enterprise]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/introduction/grafana-enterprise"
|
|
|
|
[Image rendering]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/setup-grafana/image-rendering"
|
|
[Image rendering]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/setup-grafana/image-rendering"
|
|
{{% /docs/reference %}}
|