Consolidate Grafana visualization documentation (#112393)
Co-authored-by: Jacob Valdez <jacob.valdez@grafana.com>
This commit is contained in:
Jack Baldry
co-authored by
Jacob Valdez
Jacob Valdez
parent
7bc97d5fa8
commit
d8c6af2fa7
@@ -0,0 +1,369 @@
|
||||
---
|
||||
aliases:
|
||||
- ../../reference/share_dashboard/ # /docs/grafana/next/reference/share_dashboard/
|
||||
- ../../reference/share_panel/ # /docs/grafana/next/reference/share_panel/
|
||||
- ../../share-dashboards-panels/ # /docs/grafana/next/share-dashboards-panels/
|
||||
- ../../sharing/ # /docs/grafana/next/sharing/
|
||||
- ../../sharing/playlists/ # /docs/grafana/next/sharing/playlists/
|
||||
- ../../sharing/share-dashboard/ # /docs/grafana/next/sharing/share-dashboard/
|
||||
- ../../sharing/share-panel/ # /docs/grafana/next/sharing/share-panel/
|
||||
- ../../dashboards/share-dashboard/ # /docs/grafana/next/dashboards/share-dashboard/
|
||||
- ../../dashboards/share-dashboards-panels/ # /docs/grafana/next/dashboards/share-dashboards-panels/
|
||||
keywords:
|
||||
- grafana
|
||||
- dashboard
|
||||
- documentation
|
||||
- share
|
||||
- panel
|
||||
- reporting
|
||||
- export
|
||||
- pdf
|
||||
labels:
|
||||
products:
|
||||
- cloud
|
||||
- enterprise
|
||||
- oss
|
||||
menuTitle: Sharing
|
||||
title: Share dashboards and panels
|
||||
description: Share Grafana dashboards and panels within your organization and publicly
|
||||
weight: 650
|
||||
refs:
|
||||
image-rendering:
|
||||
- pattern: /docs/grafana/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/
|
||||
grafana-enterprise:
|
||||
- pattern: /docs/grafana/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/introduction/grafana-enterprise/
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/introduction/grafana-enterprise/
|
||||
shared-dashboards:
|
||||
- pattern: /docs/grafana/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/share-dashboards-panels/shared-dashboards/
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana-cloud/visualizations/dashboards/share-dashboards-panels/shared-dashboards/
|
||||
configure-report:
|
||||
- pattern: /docs/grafana/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/create-reports/#create-a-report
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana-cloud/visualizations/dashboards/create-reports/#create-a-report
|
||||
image-rendering-config:
|
||||
- pattern: /docs/grafana/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/#configuration
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/#configuration
|
||||
max-width:
|
||||
- pattern: /docs/grafana/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/#viewport-maximum-width
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/#viewport-maximum-width
|
||||
max-height:
|
||||
- pattern: /docs/grafana/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/#viewport-maximum-height
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/#viewport-maximum-height
|
||||
max-scale:
|
||||
- pattern: /docs/grafana/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/#maximum-device-scale-factor
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/#maximum-device-scale-factor
|
||||
---
|
||||
|
||||
# Share dashboards and panels
|
||||
|
||||
Grafana enables you to share dashboards and panels with other users within your organization and in certain situations, publicly on the web. You can share using:
|
||||
|
||||
- Direct links with users in and outside of your organization
|
||||
- Snapshots
|
||||
- Embeds
|
||||
- PDFs
|
||||
- JSON files
|
||||
- Reports
|
||||
- Library panels
|
||||
|
||||
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" >}}
|
||||
Anonymous access permission is not available in Grafana Cloud. This feature is only supported for Grafana Enterprise and Grafana Open Source.
|
||||
{{< /admonition >}}
|
||||
|
||||
## Share dashboards {#share-a-dashboard}
|
||||
|
||||
You can share dashboards in the following ways:
|
||||
|
||||
- [Internally with a link](#share-an-internal-link)
|
||||
- [Externally with anyone or specific people](#share-an-external-link)
|
||||
- [As a report](#schedule-a-report)
|
||||
- [As a snapshot](#share-a-snapshot)
|
||||
- [As a PDF export](#export-a-dashboard-as-pdf)
|
||||
- [As a JSON file export](#export-a-dashboard-as-json)
|
||||
|
||||
When you share a dashboard externally as a link or by email, those dashboards are included in a list of your shared dashboards. To view the list and manage these dashboards, navigate to **Dashboards > Shared dashboards**.
|
||||
|
||||
{{< admonition type="note" >}}
|
||||
If you change a dashboard, ensure that you save the changes before sharing.
|
||||
{{< /admonition >}}
|
||||
|
||||
### Share an internal link
|
||||
|
||||
To share a customized, direct link to your dashboard within your organization, follow these steps:
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Click the dashboard you want to share.
|
||||
1. Click the **Share** drop-down list in the top-right corner and select **Share internally**.
|
||||
1. (Optional) In the **Share internally** drawer that opens, set the following options:
|
||||
- **Lock time range** - Change the current relative time range to an absolute time range. This option is enabled by default.
|
||||
- **Shorten link** - Shorten the dashboard link. This option is enabled by default.
|
||||
1. Select the theme for the dashboard. Choose from **Current**, **Dark**, or **Light**.
|
||||
1. Click **Copy link**.
|
||||
1. Send the copied link to a Grafana user with authorization to view the link.
|
||||
1. Click the **X** at the top-right corner to close the share drawer.
|
||||
|
||||
#### Quick-share an internal link
|
||||
|
||||
Once you've customized an internal link, you can share it quickly by following these steps:
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Click the dashboard you want to share.
|
||||
1. Click the **Share** button, not the drop-down list icon, to copy a shortened link.
|
||||
|
||||
This link has any customizations, like time range locking or theme, that you've previously set. These are stored in the browser scope.
|
||||
|
||||
### Share an external link
|
||||
|
||||
Externally shared dashboards allow you to share your Grafana dashboard with anyone. This is useful when you want to make your dashboard available to the world without requiring access to your Grafana organization.
|
||||
|
||||
Learn how to configure and manage externally shared dashboards in [Externally shared dashboards](ref:shared-dashboards).
|
||||
|
||||
### Schedule a report
|
||||
|
||||
{{< admonition type="note" >}}
|
||||
This feature is only available on Grafana Enterprise.
|
||||
{{< /admonition >}}
|
||||
|
||||
To share your dashboard as a report, follow these steps:
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Click the dashboard you want to share.
|
||||
1. Click the **Share** drop-down list in the top-right corner and select **Schedule a report**.
|
||||
1. [Configure the report](ref:configure-report).
|
||||
1. Depending on your schedule settings, you'll have different options at this step. Click either **Schedule send** or **Send now**.
|
||||
|
||||
You can also save the report as a draft.
|
||||
|
||||
To manage your reports, navigate to **Dashboards > Reporting > Reports**.
|
||||
|
||||
### Share a snapshot
|
||||
|
||||
A dashboard snapshot publicly shares a dashboard while removing sensitive data such as queries and panel links, leaving only visible metrics and series names. Anyone with the link can access the snapshot.
|
||||
|
||||
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.
|
||||
|
||||
{{< admonition type=note >}}
|
||||
The snapshots.raintank.io option is disabled by default in Grafana Cloud. You can update [your config file](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#external_enabled) to enable this functionality.
|
||||
{{< /admonition >}}
|
||||
|
||||
To see the other snapshots shared from your organization, navigate to **Dashboards > Snapshots** in the main menu.
|
||||
|
||||
To share your dashboard with anyone as a snapshot, follow these steps:
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Click the dashboard you want to share.
|
||||
1. Click the **Share** drop-down list in the top-right corner and select **Share snapshot**.
|
||||
1. In the **Share snapshot** drawer that opens, enter a descriptive title for the snapshot in the **Snapshot name** field.
|
||||
1. Select one of the following expiration options for the snapshot:
|
||||
- **1 Hour**
|
||||
- **1 Day**
|
||||
- **1 Week**
|
||||
- **Never**
|
||||
1. Click **Publish snapshot** or **Publish to snapshots.raintank.io**.
|
||||
|
||||
Grafana generates the link of the snapshot. Note that you can't publish dashboard snapshots containing custom panels to snapshot.raintank.io.
|
||||
|
||||
1. Click **Copy link**, and share it either within your organization or publicly on the web.
|
||||
1. Click the **X** at the top-right corner to close the share drawer.
|
||||
|
||||
#### Delete a snapshot
|
||||
|
||||
To delete existing snapshots, follow these steps:
|
||||
|
||||
1. Navigate to **Dashboards > Snapshots** in the main menu.
|
||||
1. To confirm which snapshot you're about to delete, click **View** on the snapshot row.
|
||||
|
||||
The URLs for panel and dashboard snapshots from the same dashboard look similar and viewing them first can help you distinguish them.
|
||||
|
||||
1. Click the red **x** next to the snapshot that you want to delete.
|
||||
|
||||
The snapshot is immediately deleted. You might need to clear your browser cache or use a private or incognito browser to confirm this.
|
||||
|
||||
## Export dashboards
|
||||
|
||||
In addition to sharing dashboards as links, reports, and snapshots, you can export them as PDFs or JSON files.
|
||||
|
||||
### Export a dashboard as PDF
|
||||
|
||||
{{< admonition type="note" >}}
|
||||
This feature is only available on Grafana Enterprise.
|
||||
{{< /admonition >}}
|
||||
|
||||
To export a dashboard in its current state as a PDF, follow these steps:
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Open the dashboard you want to export.
|
||||
1. Click the **Export** drop-down in the top-right corner and select **Export as PDF**.
|
||||
1. In the **Export dashboard PDF** drawer that opens, select either **Landscape** or **Portrait** for the PDF orientation.
|
||||
1. Select either **Grid** or **Simple** for the PDF layout.
|
||||
1. Set the **Zoom** level; zoom in to enlarge text, or zoom out to see more data (like table columns) per panel.
|
||||
1. Click **Generate PDF**.
|
||||
|
||||
The PDF opens in another tab where you can download it.
|
||||
|
||||
1. Click the **X** at the top-right corner to close the share drawer.
|
||||
|
||||
### Export a dashboard as JSON
|
||||
|
||||
Export a Grafana JSON file that contains everything you need, including layout, variables, styles, data sources, queries, and so on, so that you can later import the dashboard. To export a JSON file, follow these steps:
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Open the dashboard you want to export.
|
||||
1. Click the **Export** drop-down list in the top-right corner and select **Export as JSON**.
|
||||
|
||||
The **Export dashboard JSON** drawer opens.
|
||||
|
||||
1. Toggle the **Export the dashboard to use in another instance** switch to generate the JSON with a different data source UID.
|
||||
1. Click **Download file** or **Copy to clipboard**.
|
||||
1. Click the **X** at the top-right corner to close the share drawer.
|
||||
|
||||
## Share panels {#share-a-panel}
|
||||
|
||||
You can share a panels in the following ways:
|
||||
|
||||
- [Internally with a link](#share-an-internal-link)
|
||||
- [As an embed](#share-an-embed)
|
||||
- [As a snapshot](#panel-snapshot)
|
||||
|
||||
{{< admonition type="note" >}}
|
||||
If you change a panel, ensure that you save the changes before sharing.
|
||||
{{< /admonition >}}
|
||||
|
||||
### Share an internal link
|
||||
|
||||
To share a personalized, direct link to your panel within your organization, follow these steps:
|
||||
|
||||
1. Hover over any part of the panel you want to share to display the actions menu on the top right corner.
|
||||
1. Click the menu and select **Share link**.
|
||||
1. (Optional) In the **Link settings** drawer that opens, set the following options:
|
||||
- **Lock time range** - Change the current relative time range to an absolute time range. This option is enabled by default.
|
||||
- **Shorten link** - Shorten the panel link. This option is disabled by default.
|
||||
1. Select the theme for the dashboard. Choose from **Current**, **Dark**, or **Light**.
|
||||
1. Click **Copy link**.
|
||||
1. Send the copied link to a Grafana user with authorization to view it.
|
||||
1. (Optional) To [generate an image of the panel as a PNG file](ref:image-rendering), customize the image settings:
|
||||
- **Width** - In pixels. The default is 1000.
|
||||
- **Height** - In pixels. The default is 500.
|
||||
- **Scale factor** - The default is 1.
|
||||
|
||||
There are maximums for [width](ref:max-width), [height](ref:max-height), and [scale factor](ref:max-scale) in the image renderer configuration that you can customize if needed.
|
||||
|
||||
1. (Optional) Click **Generate image** to see a preview of the panel image.
|
||||
1. (Optional) Click **Download image**.
|
||||
1. Send the copied image to a Grafana user with authorization to view it.
|
||||
1. Click the **X** at the top-right corner to close the share drawer.
|
||||
|
||||
#### Query string parameters for server-side rendered images
|
||||
|
||||
When you click **Generate image** in the panel link settings, Grafana generates a PNG image of the panel with the following default parameters:
|
||||
|
||||
| Parameter | Description |
|
||||
| --------- | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| width | Width in pixels. Default is 1000. |
|
||||
| height | Height in pixels. Default is 500. |
|
||||
| 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). |
|
||||
|
||||
You can also update these parameters in the [image rendering configuration](ref:image-rendering-config).
|
||||
|
||||
The following example shows a link to a server-side rendered PNG:
|
||||
|
||||
```bash
|
||||
https://play.grafana.org/render/d-solo/ktMs4D6Mk?from=2024-09-03T11:55:44.442Z&to=2024-09-03T17:55:44.442Z&panelId=panel-13&__feature.dashboardSceneSolo&width=1000&height=500&tz=UTC
|
||||
```
|
||||
|
||||
### Share an embed
|
||||
|
||||
You can share a panel by embedding it on another website using an iframe. Users must be signed into Grafana to view the panel unless you have anonymous access permission enabled for your Grafana instance.
|
||||
|
||||
{{< admonition type="note" >}}
|
||||
Panel embedding and anonymous access permissions are not available in Grafana Cloud, even for panels in [externally shared dashboards](ref:shared-dashboards). These capabilities are only supported in Grafana Enterprise and Grafana Open Source.
|
||||
{{< /admonition >}}
|
||||
|
||||
To create a panel that can be embedded, follow these steps:
|
||||
|
||||
1. Hover over any part of the panel you want to share to display the actions menu on the top-right corner.
|
||||
1. Click the menu and select **Share embed**.
|
||||
|
||||
The **Share embed** drawer opens.
|
||||
|
||||
1. (Optional) Toggle the **Lock time range** switch to set whether the panel uses the current relative time range or an absolute time range. This option is enabled by default.
|
||||
1. Select the theme for the dashboard. Choose from **Current**, **Dark**, or **Light**.
|
||||
1. (Optional) Make any changes to the HTML that you need.
|
||||
1. Click **Copy to clipboard**.
|
||||
1. Paste the HTML code into your website code.
|
||||
1. Click the **X** at the top-right corner to close the share drawer.
|
||||
|
||||
Here's an example of what the HTML code might look like:
|
||||
|
||||
```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 visualization embedded in an iframe.
|
||||
|
||||
### Share a snapshot {#panel-snapshot}
|
||||
|
||||
A panel snapshot shares an interactive panel publicly while removing sensitive data such as queries and panel links, leaving only visible metrics and series names. Anyone with the link can access the snapshot.
|
||||
|
||||
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.
|
||||
|
||||
{{< admonition type=note >}}
|
||||
The snapshots.raintank.io option is disabled by default in Grafana Cloud. You can update [your config file](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#external_enabled) to enable this functionality.
|
||||
{{< /admonition >}}
|
||||
|
||||
To see the other snapshots shared from your organization, navigate to **Dashboards > Snapshots** in the main menu.
|
||||
|
||||
To share your panel with anyone as a snapshot, follow these steps:
|
||||
|
||||
1. Hover over any part of the panel you want to share to display the actions menu on the top-right corner.
|
||||
1. Click the menu and select **Share snapshot**.
|
||||
1. In the **Share snapshot** drawer that opens, enter a descriptive title for the snapshot in the **Snapshot name** field.
|
||||
1. Select one of the following expiration options for the snapshot:
|
||||
- **1 Hour**
|
||||
- **1 Day**
|
||||
- **1 Week**
|
||||
- **Never**
|
||||
1. Click **Publish snapshot** or **Publish to snapshots.raintank.io**.
|
||||
|
||||
Grafana generates the link of the snapshot. Note that you can't publish snapshots that include custom panels to snapshot.raintank.io.
|
||||
|
||||
1. Click **Copy link**, and share it either within your organization or publicly on the web.
|
||||
1. Click the **X** at the top-right corner to close the share drawer.
|
||||
|
||||
#### Delete a snapshot
|
||||
|
||||
To delete existing snapshots, follow these steps:
|
||||
|
||||
1. Navigate to **Dashboards > Snapshots** in the main menu.
|
||||
1. To confirm which snapshot you're about to delete, click **View** on the snapshot row.
|
||||
|
||||
The URLs for panel and dashboard snapshots from the same dashboard look similar and viewing them first can help you distinguish them.
|
||||
|
||||
1. Click the red **x** next to the snapshot URL that you want to delete.
|
||||
|
||||
The snapshot is immediately deleted. You may need to clear your browser cache or use a private or incognito browser to confirm this.
|
||||
+314
@@ -0,0 +1,314 @@
|
||||
---
|
||||
aliases:
|
||||
- ../../../dashboards/dashboard-public/ # /docs/grafana/next/dashboards/dashboard-public/
|
||||
- ../../../dashboards/share-dashboards-panels/shared-dashboards/ # /docs/grafana/next/dashboards/share-dashboards-panels/shared-dashboards/
|
||||
labels:
|
||||
products:
|
||||
- cloud
|
||||
- enterprise
|
||||
- oss
|
||||
title: Externally shared dashboards
|
||||
menuTitle: Shared dashboards
|
||||
description: Make your Grafana dashboards externally shared and share them with anyone
|
||||
weight: 8
|
||||
refs:
|
||||
dashboard-sharing:
|
||||
- pattern: /docs/grafana/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/share-dashboards-panels/
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana-cloud/visualizations/dashboards/share-dashboards-panels/
|
||||
custom-branding:
|
||||
- pattern: /docs/grafana/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/configure-custom-branding/
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/configure-custom-branding/
|
||||
dashboard-insights-documentation:
|
||||
- pattern: /docs/grafana/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/assess-dashboard-usage/#dashboard-insights
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana-cloud/visualizations/dashboards/assess-dashboard-usage/
|
||||
caching:
|
||||
- pattern: /docs/grafana/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/administration/data-source-management/#query-and-resource-caching
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/administration/data-source-management/#query-and-resource-caching
|
||||
grafana-enterprise:
|
||||
- pattern: /docs/grafana/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/introduction/grafana-enterprise/
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/introduction/grafana-enterprise/
|
||||
---
|
||||
|
||||
# Externally shared dashboards
|
||||
|
||||
{{< admonition type="note" >}}
|
||||
This feature was previously called **Public dashboards**.
|
||||
{{< /admonition >}}
|
||||
|
||||
Externally shared dashboards allow you to share your Grafana dashboard with anyone. This is useful when you want to make your dashboard available to the world without requiring access to your Grafana organization.
|
||||
|
||||
If you change a dashboard, ensure that you save the changes before sharing.
|
||||
|
||||
{{< admonition type="warning" >}}
|
||||
Sharing your dashboard externally could result in a large number of queries to the data sources used by your dashboard.
|
||||
This can be mitigated by using the Enterprise [caching](ref:caching) and/or rate limiting features.
|
||||
{{< /admonition >}}
|
||||
|
||||
## Shared dashboards list
|
||||
|
||||
You can see a list of all your externally shared dashboards in one place by navigating to **Dashboards > Shared dashboards**. For each dashboard in the list, the page displays:
|
||||
|
||||
- Link to view the externally shared version of the dashboard
|
||||
- Link to the shared dashboard configuration
|
||||
- Options to pause or revoke access to the external dashboard
|
||||
|
||||
You can also click the name of the dashboard to navigate to the dashboard internally.
|
||||
|
||||
## Important notes about sharing your dashboard externally
|
||||
|
||||
- Anyone with the URL can access the dashboard.
|
||||
- Externally shared dashboards are read-only.
|
||||
- Arbitrary queries **cannot** be run against your data sources through externally shared dashboards. Externally shared dashboards can only execute the queries stored on the original dashboard.
|
||||
|
||||
## Share externally with specific people
|
||||
|
||||
{{< admonition type="note">}}
|
||||
This feature was previously called **email sharing**.
|
||||
|
||||
Available in [Grafana Enterprise](ref:grafana-enterprise) and [Grafana Cloud](/docs/grafana-cloud).
|
||||
{{< /admonition >}}
|
||||
|
||||
<!-- {{< docs/private-preview product="Sharing externally with specific people" >}}-->
|
||||
|
||||
{{< admonition type="note" >}}
|
||||
Sharing externally with specific people is currently in [private preview](https://grafana.com/docs/release-life-cycle/#private-preview). Please contact support to have this feature enabled.
|
||||
|
||||
This feature will incur a cost once it is promoted to general availability.
|
||||
{{< /admonition >}}
|
||||
|
||||
To share a dashboard with specific external users, you can send them a link by email. Use this option when you only want to share your dashboard with specific people. When you share dashboards by email, recipients receive a one-time use link that's valid for **one hour**. Once the link is used, the viewer has access to the shared dashboard for **30 days**.
|
||||
|
||||
<!--When you share a dashboard with an email link, your organization is billed per user, regardless of how many dashboards are shared. Grafana bills monthly per user until access is revoked.-->
|
||||
|
||||
To share a dashboard with specific people, follow these steps:
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Click the dashboard you want to share.
|
||||
1. Click the **Share** drop-down list in the top-right corner and select **Share externally**.
|
||||
|
||||
The **Share externally** drawer opens.
|
||||
|
||||
1. In the **Link access** drop-down list, select **Only specific people**.
|
||||
1. Click the checkbox confirming that you understand payment is required to add users.
|
||||
1. Click **Accept**.
|
||||
1. In the **Invite** field, enter the email address of the person you want to invite and click **Invite** and repeat this process for all the people you want to invite.
|
||||
|
||||
You can only invite one person at a time.
|
||||
|
||||
1. (Optional) Set the following options:
|
||||
- **Enable time range** - Allow people accessing the link to change the time range. This configuration screen shows the default time range of the dashboard.
|
||||
- **Display annotations** - Allow people accessing the link to view the dashboard annotations.
|
||||
1. (Optional) Click **Copy external link** and send the copied URL to any external user.
|
||||
1. Click the **X** at the top-right corner to close the share drawer.
|
||||
|
||||
Once you've shared a dashboard externally, a **Public** label is displayed in the header of the dashboard.
|
||||
|
||||
### Viewers requesting access
|
||||
|
||||
If a viewer without access tries to navigate to the shared dashboard, they'll be asked to request access by providing their email. They'll receive an email with a new one-time use link if the email they provided has already been invited to view the shared dashboard and hasn't been revoked.
|
||||
|
||||
### Revoke access for a viewer
|
||||
|
||||
You can revoke access to the entire dashboard using the steps in [Update access to an external dashboard link](#update-access-to-an-external-dashboard-link), but you can also revoke access to the dashboard for specific people.
|
||||
|
||||
To revoke access for a viewer, follow these steps:
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Click the dashboard you want to share.
|
||||
1. Click the **Share** drop-down list in the top-right corner and select **Share externally**.
|
||||
1. In the **Share externally** drawer that opens, click the menu icon (three dots) next to the email address of the viewer for whom you'd like to revoke access.
|
||||
1. Click **Revoke access**.
|
||||
1. Click the **X** at the top-right corner to close the share drawer.
|
||||
|
||||
The viewer immediately no longer has access to the dashboard, nor can they use any existing one-time use links they may have.
|
||||
|
||||
### Re-invite a viewer
|
||||
|
||||
To re-invite a viewer, follow these steps:
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Click the dashboard you want to share.
|
||||
1. Click the **Share** drop-down list in the top-right corner and select **Share externally**.
|
||||
1. In the **Share externally** drawer that opens, click the menu icon (three dots) next to the email address of the viewer you'd like to invite again.
|
||||
1. Click **Resend invite**.
|
||||
1. Click the **X** at the top-right corner to close the share drawer.
|
||||
|
||||
The viewer receives an email with a new one-time use link. This invalidates all previously issued links for that viewer.
|
||||
|
||||
### View shared dashboard users
|
||||
|
||||
To see a list of users who have accessed your externally shared dashboard by way of an emailed link, follow these steps:
|
||||
|
||||
1. Click **Administration** in in the main menu.
|
||||
1. Select **Users and access** > **Users**.
|
||||
1. On the **Users** page, click the **Shared dashboard users** tab.
|
||||
|
||||
On this screen, you can see:
|
||||
|
||||
- The earliest time a user has been active in a dashboard
|
||||
- When they last accessed a shared dashboard
|
||||
- The dashboards they have access to
|
||||
- Their role
|
||||
|
||||
You can also revoke a user's access to all shared dashboards on from this tab.
|
||||
|
||||
### Access limitations
|
||||
|
||||
One-time use links use browser cookies, so when a viewer is granted access through one of these links, they'll only have access on the browser they used to claim the link.
|
||||
|
||||
A single viewer can't generate multiple valid one-time use links for a dashboard. When a new one-time use link is issued for a viewer, all previous ones are invalidated.
|
||||
|
||||
If a Grafana user has read access to the parent dashboard, they can view the externally shared dashboard without needing to have access granted.
|
||||
|
||||
## Share externally to anyone with a link
|
||||
|
||||
To share your dashboard so that anyone with the link can access it, follow these steps:
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Click the dashboard you want to share.
|
||||
1. Click the **Share** drop-down list in the top-right corner and select **Share externally**.
|
||||
|
||||
The **Share externally** drawer opens.
|
||||
|
||||
1. In the **Link access** drop-down list, select **Anyone with the link**.
|
||||
1. Click the checkbox confirming that you understand the entire dashboard will be public.
|
||||
1. Click **Accept**.
|
||||
1. (Optional) Set the following options:
|
||||
- **Enable time range** - Allow people accessing the link to change the time range. This configuration screen shows the default time range of the dashboard.
|
||||
- **Display annotations** - Allow people accessing the link to view the dashboard annotations.
|
||||
1. Click the **X** at the top-right corner to close the share drawer.
|
||||
|
||||
Now anyone with the link can access the dashboard until you pause or revoke access to it.
|
||||
|
||||
Once you've shared a dashboard externally, a **Public** label is displayed in the header of the dashboard.
|
||||
|
||||
### Update access to an external dashboard link
|
||||
|
||||
You can update the access to externally shared dashboard links by following these steps:
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Click the dashboard you want to share.
|
||||
1. Click the **Share** drop-down list in the top-right corner and select **Share externally**.
|
||||
1. In the **Share externally** drawer that opens, do one of the following:
|
||||
- Click **Pause access** so that people can't access the dashboard, but the link is maintained.
|
||||
- Click **Resume access** so that people can access the dashboard again.
|
||||
- Click **Revoke access** so that people can't access the dashboard unless a new external link is generated. Confirm that you want to revoke the link.
|
||||
1. Click the **X** at the top-right corner to close the share drawer.
|
||||
|
||||
## Assess shared dashboard usage
|
||||
|
||||
{{< admonition type="note" >}}
|
||||
Available in [Grafana Enterprise](ref:grafana-enterprise) and [Grafana Cloud](/docs/grafana-cloud).
|
||||
{{< /admonition >}}
|
||||
|
||||
You can check usage analytics about your externally shared dashboard by clicking the insights icon in the dashboard header:
|
||||
|
||||
|
||||
|
||||
Learn more about the kind of information provided in the [dashboard insights documentation](ref:dashboard-insights-documentation).
|
||||
|
||||
## Supported data sources
|
||||
|
||||
Externally shared dashboards _should_ work with any data source that has the properties `backend` and `alerting` both set to true in its `plugin.json`. However, this can't always be
|
||||
guaranteed because plugin developers can override this functionality. The following lists include data sources confirmed to work with externally shared dashboards and data sources that should work, but have not been confirmed as compatible.
|
||||
|
||||
### Confirmed
|
||||
|
||||
{{< column-list >}}
|
||||
|
||||
- ClickHouse
|
||||
- CloudWatch
|
||||
- Elasticsearch
|
||||
- Infinity
|
||||
- InfluxDB
|
||||
- Loki
|
||||
- Microsoft SQL Server
|
||||
- MongoDB
|
||||
- MySQL
|
||||
- Oracle Database
|
||||
- PostgreSQL
|
||||
- Prometheus
|
||||
- Redis
|
||||
- SQLite
|
||||
|
||||
{{< /column-list >}}
|
||||
|
||||
### Unsupported
|
||||
|
||||
- DynamoDB
|
||||
- Dynatrace
|
||||
- Graphite
|
||||
- Google Sheets
|
||||
|
||||
### Unconfirmed
|
||||
|
||||
{{< column-list >}}
|
||||
|
||||
- Altinity plugin for ClickHouse
|
||||
- Amazon Athena
|
||||
- Amazon Redshift
|
||||
- Amazon Timestream
|
||||
- Apache Cassandra
|
||||
- AppDynamics
|
||||
- Azure Data Explorer Datasource
|
||||
- Azure Monitor
|
||||
- CSV
|
||||
- DB2 Datasource
|
||||
- Databricks
|
||||
- Datadog
|
||||
- Dataset
|
||||
- Druid
|
||||
- GitHub
|
||||
- Google BigQuery
|
||||
- Grafana for YNAB
|
||||
- Honeycomb
|
||||
- Jira
|
||||
- Mock
|
||||
- Neo4j Datasource
|
||||
- New Relic
|
||||
- OPC UA (Unified Architecture)
|
||||
- Open Distro for Elasticsearch
|
||||
- OpenSearch
|
||||
- OpenTSDB
|
||||
- Orbit
|
||||
- SAP HANA®
|
||||
- Salesforce
|
||||
- Sentry
|
||||
- ServiceNow
|
||||
- Snowflake
|
||||
- Splunk
|
||||
- Splunk Infrastructure Monitoring
|
||||
- Sqlyze data source
|
||||
- TDengine
|
||||
- Vertica
|
||||
- Wavefront
|
||||
- X-Ray
|
||||
- kdb+
|
||||
- simple grpc data source
|
||||
|
||||
{{< /column-list >}}
|
||||
|
||||
## Limitations
|
||||
|
||||
- Panels that use frontend data sources will fail to fetch data.
|
||||
- Variables and queries including variables are not supported.
|
||||
- Exemplars will be omitted from the panel.
|
||||
- Only annotations that query the `-- Grafana --` data source and use the query type `Annotations & Alerts` are supported.
|
||||
- Organization annotations are not supported.
|
||||
- Grafana Live and real-time event streams are not supported.
|
||||
- Library panels are not supported.
|
||||
- Data sources using Reverse Proxy functionality are not supported.
|
||||
|
||||
## Custom branding
|
||||
|
||||
If you're a Grafana Enterprise customer, you can use custom branding to change the appearance of an externally shared dashboard footer. For more information, refer to [Custom branding](ref:custom-branding).
|
||||
Reference in New Issue
Block a user