mirror of
https://github.com/grafana/grafana.git
synced 2024-11-22 08:56:43 -06:00
Docs: update docs to reflect new sharing UI (#90630)
Co-authored-by: Juan Cabanas <juan.cabanas@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
This commit is contained in:
Isabel Matwawana
GitHub
parent
f80d3d687d
commit
dbf0949ca7
@ -118,7 +118,7 @@ Ensure you have a public dashboard footer logo or footer text set if you don't w
|
||||
|
||||
#### Learn more
|
||||
|
||||
[Configure custom branding documentation](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/configure-custom-branding/#custom-branding-for-public-dashboards) for public dashboards
|
||||
[Configure custom branding documentation](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/configure-custom-branding/#custom-branding-for-shared-dashboards) for public dashboards
|
||||
|
||||
### Subfolders cause very rare issues with folders that have forward slashes in their names
|
||||
|
||||
|
||||
@ -31,17 +31,17 @@ cards:
|
||||
href: ./variables/
|
||||
description: Add variables to metric queries and panel titles to create interactive and dynamic dashboards.
|
||||
height: 24
|
||||
- title: Public dashboards
|
||||
href: ./dashboard-public/
|
||||
description: Make your Grafana dashboards public and share them with anyone without requiring access to your Grafana organization.
|
||||
height: 24
|
||||
- title: Reporting
|
||||
href: ./create-reports/
|
||||
description: Automatically generate and share PDF reports from your Grafana dashboards.
|
||||
height: 24
|
||||
- title: Sharing
|
||||
href: ./share-dashboards-panels/
|
||||
description: Share Grafana dashboards and panels within your organization using links, snapshots, and JSON exports.
|
||||
description: Share Grafana dashboards and panels using links, snapshots, embeds, and exports.
|
||||
height: 24
|
||||
- title: Shared dashboards
|
||||
href: ./share-dashboards-panels/shared-dashboards/
|
||||
description: Share your dashboards with anyone without requiring access to your Grafana organization.
|
||||
height: 24
|
||||
refs:
|
||||
panels:
|
||||
|
||||
@ -34,7 +34,7 @@ refs:
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-security/export-logs/
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-security/export-logs/
|
||||
enabled:
|
||||
dashboard-sharing:
|
||||
- pattern: /docs/grafana/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/#public_dashboards
|
||||
- pattern: /docs/grafana-cloud/
|
||||
@ -79,7 +79,7 @@ For every dashboard and data source, you can access usage information.
|
||||
|
||||
To see dashboard usage information, click the dashboard insights icon in the header.
|
||||
|
||||
{{< figure src="/media/docs/grafana/dashboards/screenshot-dashboard-insights-11.2.png" alt="Dashboard insights icon" >}}
|
||||
|
||||
|
||||
Dashboard insights show the following information:
|
||||
|
||||
@ -88,7 +88,7 @@ Dashboard insights show the following information:
|
||||
|
||||
{{< figure src="/static/img/docs/enterprise/dashboard_insights_stats.png" max-width="400px" class="docs-image--no-shadow" alt="Stats tab" >}}{{< figure src="/static/img/docs/enterprise/dashboard_insights_users.png" max-width="400px" class="docs-image--no-shadow" alt="Users and activity tab" >}}
|
||||
|
||||
If public dashboards are [enabled](ref:enabled), you'll also see a **Public dashboards** tab in your analytics.
|
||||
If [dashboard sharing](ref:dashboard-sharing) is enabled, you'll also see a **Shared dashboards** tab in your analytics.
|
||||
|
||||
### Data source insights
|
||||
|
||||
|
||||
@ -148,7 +148,7 @@ Each panel can have its own set of links that are shown in the upper left of the
|
||||
|
||||
Click the icon next to the panel title to see available panel links.
|
||||
|
||||
{{< figure src="/media/docs/grafana/screenshot-panel-links.png" width="200px" alt="List of panel links displayed" >}}
|
||||
{{< figure src="/media/docs/grafana/dashboards/screenshot-panel-links-v11.3.png" max-width="550px" alt="List of panel links displayed" >}}
|
||||
|
||||
### Add a panel link
|
||||
|
||||
|
||||
@ -37,15 +37,20 @@ You can control permissions for library panels using [role-based access control
|
||||
|
||||
## Create a library panel
|
||||
|
||||
When you create a library panel, the panel on the source dashboard is converted to a library panel as well. You need to save the original dashboard once a panel is converted.
|
||||
Library panels can be reused in different dashboards throughout Grafana. When you create a library panel, the panel on the source dashboard is converted to a library panel as well. You need to save the original dashboard once a panel is converted.
|
||||
|
||||
1. Click **Edit** in the top-right corner of the dashboard.
|
||||
1. On the panel you want to update, hover over any part of the panel to display the menu icon on the top-right corner.
|
||||
1. Click the menu icon and select **More > Create library panel**.
|
||||
1. In **Library panel name**, enter the name.
|
||||
1. In **Save in folder**, select the folder to save the library panel.
|
||||
1. Click **Create library panel**.
|
||||
1. Click **Save dashboard** and **Exit edit**.
|
||||
To create a library panel, follow these steps:
|
||||
|
||||
1. In the top-right corner of the dashboard, click **Edit**.
|
||||
1. Hover over any part of the panel you want to share to display the actions menu on the top right corner.
|
||||
1. Click **More > New library panel**.
|
||||
1. In the **Library panel name** field, enter the name.
|
||||
1. In the **Save in folder** drop-down list, 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. Click **Save dashboard**.
|
||||
1. (Optional) Enter a description of the changes you've made.
|
||||
1. Click **Save**.
|
||||
1. Click **Exit edit**.
|
||||
|
||||
Once created, you can modify the library panel using any dashboard on which it appears. After you save the changes, all instances of the library panel reflect these modifications.
|
||||
|
||||
@ -53,11 +58,13 @@ Once created, you can modify the library panel using any dashboard on which it a
|
||||
|
||||
Add a Grafana library panel to a dashboard when you want to provide visualizations to other dashboard users.
|
||||
|
||||
To add a library panel, follow these steps:
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Click **New** and select **New Dashboard** in the dropdown.
|
||||
1. Click **New** and select **New Dashboard** in the drop-down list.
|
||||
1. On the empty dashboard, click **+ Add library panel**.
|
||||
|
||||
You'll see a list of your library panels.
|
||||
The **Add panel from panel library** drawer opens.
|
||||
|
||||
1. Filter the list or search to find the panel you want to add.
|
||||
1. Click a panel to add it to the dashboard.
|
||||
@ -69,6 +76,8 @@ Add a Grafana library panel to a dashboard when you want to provide visualizatio
|
||||
|
||||
Unlink a library panel when you want to make a change to the panel and not affect other instances of the library panel.
|
||||
|
||||
To unlink a library panel, follow these steps:
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Click **Library panels**.
|
||||
1. Select a library panel that is being used in dashboards.
|
||||
@ -107,8 +116,9 @@ Alternatively, if you know where the library panel that you want to replace is b
|
||||
|
||||
You can view a list of available library panels and see where those panels are being used.
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Click **Library panels**.
|
||||
To view and manage library panels, follow these steps:
|
||||
|
||||
1. Click **Dashboards > Library panels** in the main menu.
|
||||
|
||||
You can see a list of previously defined library panels.
|
||||
{{< figure src="/media/docs/grafana/panels-visualizations/screenshot-library-panel-list-9-5.png" class="docs-image--no-shadow" max-width= "900px" alt="Library panels page with list of library panels" >}}
|
||||
@ -123,8 +133,8 @@ You can view a list of available library panels and see where those panels are b
|
||||
|
||||
## Delete a library panel
|
||||
|
||||
Delete a library panel when you no longer need it.
|
||||
To delete a library panel that you no longer need, follow these steps:
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Click **Library panels**.
|
||||
1. Click **Dashboards > Library panels** in the main menu.
|
||||
1. Click the delete icon next to the library panel name.
|
||||
1. Click **Delete**.
|
||||
|
||||
@ -1,273 +0,0 @@
|
||||
---
|
||||
labels:
|
||||
products:
|
||||
- cloud
|
||||
- enterprise
|
||||
- oss
|
||||
title: Public dashboards
|
||||
description: Make your Grafana dashboards public and share them with anyone
|
||||
weight: 350
|
||||
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/
|
||||
---
|
||||
|
||||
# Public dashboards
|
||||
|
||||
> **Warning:** Making your dashboard public could result in a large number of queries to the data sources used by your dashboard.
|
||||
> This can be mitigated by utilizing the enterprise [caching](ref:caching) and/or rate limiting features.
|
||||
|
||||
Public 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. This differs from [dashboard sharing](ref:dashboard-sharing), which either requires recipients to be users in the same Grafana organization or provides limited information, as with a snapshot.
|
||||
|
||||
You can see a list of all your public dashboards in one place by navigating to **Dashboards > Public dashboards**. For each dashboard in the list, the page displays the status, a link to view the dashboard, a link to the public dashboard configuration, and the option to revoke the public URL.
|
||||
|
||||
## Security implications of making your dashboard public
|
||||
|
||||
- Anyone with the URL can access the dashboard.
|
||||
- Public dashboards are read-only.
|
||||
- Arbitrary queries **cannot** be run against your data sources through public dashboards. Public dashboards can only execute the
|
||||
queries stored on the original dashboard.
|
||||
|
||||
## Make a dashboard public
|
||||
|
||||
1. Click **Share** in the top-right corner of the dashboard.
|
||||
1. Click the **Public dashboard** tab.
|
||||
1. Acknowledge the implications of making the dashboard public by selecting all the checkboxes.
|
||||
1. Click **Generate public URL** to make the dashboard public and make your link live.
|
||||
1. Copy the public dashboard link if you'd like to share it. You can always come back later for it.
|
||||
|
||||
Once you've made the dashboard public, a **Public** tag is displayed in the header of the dashboard.
|
||||
|
||||
## Pause access
|
||||
|
||||
1. Click **Share** in the top-right corner of the dashboard.
|
||||
1. Click the **Public dashboard** tab.
|
||||
1. Enable the **Pause sharing dashboard** toggle.
|
||||
|
||||
The dashboard is no longer accessible, even with the link, until you make it shareable again.
|
||||
|
||||
## Revoke access
|
||||
|
||||
1. Click **Share** in the top-right corner of the dashboard.
|
||||
1. Click the **Public dashboard** tab.
|
||||
1. Click **Revoke public URL** to delete the public dashboard.
|
||||
|
||||
The link no longer works. You must create a new public URL, as in [Make a dashboard public](#make-a-dashboard-public).
|
||||
|
||||
## Email sharing
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
|
||||
Available in [private preview](/docs/release-life-cycle/) in [Grafana Cloud](/docs/grafana-cloud). This feature will have a cost by active users after being promoted into general availability.
|
||||
|
||||
Please contact support to have the feature enabled.
|
||||
|
||||
{{% /admonition %}}
|
||||
|
||||
Email sharing allows you to share your public dashboard with only specific people by email, instead of having it accessible to anyone with the URL. When you use email sharing, recipients receive a one-time use link that's valid for **one hour**. Once the link is used, the viewer has access to the public dashboard for **30 days**.
|
||||
|
||||
### Invite a viewer
|
||||
|
||||
1. Click **Share** in the top-right corner of the dashboard.
|
||||
1. Click the **Public dashboard** tab.
|
||||
1. Acknowledge the implications of making the dashboard public by selecting all the checkboxes.
|
||||
1. Click **Generate public URL** to make the dashboard public and make your link live.
|
||||
1. Under Can view dashboard, click **Only specified people**.
|
||||
1. Enter the email you want to share the public dashboard with.
|
||||
1. Click **Invite**.
|
||||
1. The recipient will receive an email with a one-time use link.
|
||||
|
||||
### Viewers requesting access
|
||||
|
||||
If a viewer without access tries to navigate to the public dashboard, they'll be asked to request access by providing their email. They will receive an email with a new one-time use link if the email they provided has already been invited to view the public dashboard and has not been revoked.
|
||||
|
||||
If the viewer doesn't have an invitation or it's been revoked, you won't be notified and no link is sent.
|
||||
|
||||
### Revoke access for a viewer
|
||||
|
||||
1. Click **Share** in the top-right corner of the dashboard.
|
||||
1. Click the **Public dashboard** tab.
|
||||
1. Click **Revoke** on the viewer you'd like to revoke access for.
|
||||
|
||||
Immediately, the viewer no longer has access to the public dashboard, nor can they use any existing one-time use links they may have.
|
||||
|
||||
### Reinvite a viewer
|
||||
|
||||
1. Click **Share** in the top-right corner of the dashboard.
|
||||
1. Click the **Public dashboard** tab.
|
||||
1. Click **Resend** on the viewer you'd like to re-share the public dashboard with.
|
||||
|
||||
The viewer will receive an email with a new one-time use link. This will invalidate all previously issued links for that viewer.
|
||||
|
||||
### View public dashboard users
|
||||
|
||||
To see a list of users who have accessed your dashboard by way of email sharing, take the following steps:
|
||||
|
||||
1. In the main sidebar navigation, click **Administration**.
|
||||
1. Click **Users**.
|
||||
1. Click the **Public dashboard users** tab.
|
||||
|
||||
From here, you can see the earliest time a user has been active in a dashboard, which public dashboards they have access to, and their role.
|
||||
|
||||
### Access limitations
|
||||
|
||||
One-time use links use browser cookies, so when a viewer is granted access through one of these links, they will only have access on the browser they used to claim the link.
|
||||
|
||||
A single viewer cannot generate multiple valid one-time use links. 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 public dashboard without needing to have access granted.
|
||||
|
||||
## Assess public dashboard usage
|
||||
|
||||
> **Note:** Available in [Grafana Enterprise](ref:grafana-enterprise) and [Grafana Cloud](/docs/grafana-cloud).
|
||||
|
||||
You can check usage analytics about your public dashboard by clicking the insights icon in the dashboard header:
|
||||
|
||||
{{< figure src="/media/docs/grafana/dashboards/screenshot-dashboard-insights-11.2.png" max-width="400px" class="docs-image--no-shadow" alt="Dashboard insights icon" >}}
|
||||
|
||||
Learn more about the kind of information provided in the [dashboard insights documentation](ref:dashboard-insights-documentation).
|
||||
|
||||
## Supported data sources
|
||||
|
||||
Public 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 public dashboards and data sources that should work, but have not been confirmed as compatible.
|
||||
|
||||
### Confirmed:
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>
|
||||
<ul>
|
||||
<li>ClickHouse</li>
|
||||
<li>CloudWatch</li>
|
||||
<li>Elasticsearch</li>
|
||||
<li>Infinity</li>
|
||||
<li>InfluxDB</li>
|
||||
<li>Loki</li>
|
||||
<li>Microsoft SQL Server</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>
|
||||
<ul>
|
||||
<li>MongoDB</li>
|
||||
<li>MySQL</li>
|
||||
<li>Oracle Database</li>
|
||||
<li>PostgreSQL</li>
|
||||
<li>Prometheus</li>
|
||||
<li>Redis</li>
|
||||
<li>SQLite</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### Unsupported:
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>
|
||||
<ul>
|
||||
<li>Graphite</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### Unconfirmed:
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>
|
||||
<ul>
|
||||
<li>Altinity plugin for ClickHouse</li>
|
||||
<li>Amazon Athena</li>
|
||||
<li>Amazon Redshift</li>
|
||||
<li>Amazon Timestream</li>
|
||||
<li>Apache Cassandra</li>
|
||||
<li>AppDynamics</li>
|
||||
<li>Azure Data Explorer Datasource</li>
|
||||
<li>Azure Monitor</li>
|
||||
<li>CSV</li>
|
||||
<li>DB2 Datasource</li>
|
||||
<li>Databricks</li>
|
||||
<li>Datadog</li>
|
||||
<li>Dataset</li>
|
||||
<li>Druid</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>
|
||||
<ul>
|
||||
<li>Dynatrace</li>
|
||||
<li>GitHub</li>
|
||||
<li>Google BigQuery</li>
|
||||
<li>Grafana for YNAB</li>
|
||||
<li>Honeycomb</li>
|
||||
<li>Jira</li>
|
||||
<li>Mock</li>
|
||||
<li>Neo4j Datasource</li>
|
||||
<li>New Relic</li>
|
||||
<li>OPC UA (Unified Architecture)</li>
|
||||
<li>Open Distro for Elasticsearch</li>
|
||||
<li>OpenSearch</li>
|
||||
<li>OpenTSDB</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>
|
||||
<ul>
|
||||
<li>Orbit</li>
|
||||
<li>SAP HANA®</li>
|
||||
<li>Salesforce</li>
|
||||
<li>Sentry</li>
|
||||
<li>ServiceNow</li>
|
||||
<li>Snowflake</li>
|
||||
<li>Splunk</li>
|
||||
<li>Splunk Infrastructure Monitoring</li>
|
||||
<li>Sqlyze data source</li>
|
||||
<li>TDengine</li>
|
||||
<li>Vertica</li>
|
||||
<li>Wavefront</li>
|
||||
<li>X-Ray</li>
|
||||
<li>kdb+</li>
|
||||
<li>simple grpc data source</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## Limitations
|
||||
|
||||
- Panels that use frontend data sources will fail to fetch data.
|
||||
- Template variables are not supported.
|
||||
- Exemplars will be omitted from the panel.
|
||||
- Only annotations that query the `-- Grafana --` data source 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 a public dashboard footer. For more information, refer to [Custom branding](ref:custom-branding).
|
||||
348
docs/sources/dashboards/share-dashboards-panels/_index.md
Normal file
348
docs/sources/dashboards/share-dashboards-panels/_index.md
Normal file
@ -0,0 +1,348 @@
|
||||
---
|
||||
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
|
||||
- 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: 85
|
||||
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/grafana-cloud/visualizations/dashboards/share-dashboards-panels/shared-dashboards/
|
||||
configure-report:
|
||||
- pattern: /docs/grafana/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/dashboards/create-reports/#create-or-update-a-report
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana-cloud/visualizations/dashboards/create-reports/#create-or-update-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
|
||||
---
|
||||
|
||||
# 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" >}}
|
||||
As of Grafana 8.0, anonymous access permission is not available in Grafana Cloud.
|
||||
{{< /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 in 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
|
||||
|
||||
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. Do one or both of the following:
|
||||
- Click **Copy link**.
|
||||
- Click **Render image**, which [renders the panel as a PNG image](ref:image-rendering).
|
||||
1. Send the copied link or image URL 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 **Render 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 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+. |
|
||||
|
||||
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.
|
||||
|
||||
{{< admonition type="note" >}}
|
||||
As of Grafana 8.0, anonymous access permission is no longer available for Grafana Cloud.
|
||||
{{< /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.
|
||||
@ -1,250 +0,0 @@
|
||||
---
|
||||
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
|
||||
description: Share Grafana dashboards and panels within your organization and publicly
|
||||
weight: 700
|
||||
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/
|
||||
---
|
||||
|
||||
# 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 main menu.
|
||||
1. Click the dashboard you want to share.
|
||||
1. Click **Share** in the top-right corner.
|
||||
|
||||
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 **Publish 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** in the dialog box to remove the snapshot from your Grafana instance.
|
||||
|
||||
#### Delete a snapshot
|
||||
|
||||
To delete existing snapshots, follow these steps:
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Click **Snapshots** to go to the snapshots management page.
|
||||
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.
|
||||
|
||||
### Export a dashboard as JSON
|
||||
|
||||
The dashboard export action creates 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.
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Open the dashboard you want to export.
|
||||
1. Click **Share** in the top-right corner.
|
||||
1. Click **Export**.
|
||||
|
||||
If you're exporting the dashboard to use in another instance, with different data source UIDs, enable the **Export for sharing externally** switch.
|
||||
|
||||
1. Click **Save to file**.
|
||||
|
||||
Grafana downloads a JSON file to your local machine.
|
||||
|
||||
#### Make a dashboard portable
|
||||
|
||||
If you want to export a dashboard for others to use, you can add template variables for things like a metric prefix (use a constant variable) and server name.
|
||||
|
||||
A template variable of the type `Constant` is automatically hidden in the dashboard, and is also added as a required input when the dashboard is imported.
|
||||
|
||||
## Export dashboard as PDF
|
||||
|
||||
You can generate and save PDF files of any dashboard.
|
||||
|
||||
{{< admonition type="note" >}}
|
||||
Available in [Grafana Enterprise](ref:grafana-enterprise) and [Grafana Cloud](/docs/grafana-cloud/).
|
||||
{{< /admonition >}}
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Click the dashboard you want to share.
|
||||
1. Click **Share** in the top-right corner.
|
||||
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](ref: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.
|
||||
|
||||
{{< admonition type="note" >}}
|
||||
As of Grafana 11, the option to publish to [snapshots.raintank.io](http://snapshots.raintank.io) is no longer available for Grafana Cloud.
|
||||
{{< /admonition >}}
|
||||
|
||||
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 **Publish 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** in the dialog box to remove the snapshot from your Grafana instance.
|
||||
|
||||
#### Delete a snapshot
|
||||
|
||||
To delete existing snapshots, follow these steps:
|
||||
|
||||
1. Click **Dashboards** in the main menu.
|
||||
1. Click **Snapshots** to go to the snapshots management page.
|
||||
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.
|
||||
|
||||
### 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.
|
||||
|
||||
{{< admonition type="note" >}}
|
||||
As of Grafana 8.0, anonymous access permission is no longer available for Grafana Cloud.
|
||||
{{< /admonition >}}
|
||||
|
||||
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. Click **Save dashboard**.
|
||||
@ -0,0 +1,331 @@
|
||||
---
|
||||
aliases:
|
||||
- ../dashboard-public/ # /docs/grafana/latest/dashboards/dashboard-public/
|
||||
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 >}}
|
||||
|
||||
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 to they have access
|
||||
- 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:
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>
|
||||
<ul>
|
||||
<li>ClickHouse</li>
|
||||
<li>CloudWatch</li>
|
||||
<li>Elasticsearch</li>
|
||||
<li>Infinity</li>
|
||||
<li>InfluxDB</li>
|
||||
<li>Loki</li>
|
||||
<li>Microsoft SQL Server</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>
|
||||
<ul>
|
||||
<li>MongoDB</li>
|
||||
<li>MySQL</li>
|
||||
<li>Oracle Database</li>
|
||||
<li>PostgreSQL</li>
|
||||
<li>Prometheus</li>
|
||||
<li>Redis</li>
|
||||
<li>SQLite</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### Unsupported:
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>
|
||||
<ul>
|
||||
<li>Graphite</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### Unconfirmed:
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>
|
||||
<ul>
|
||||
<li>Altinity plugin for ClickHouse</li>
|
||||
<li>Amazon Athena</li>
|
||||
<li>Amazon Redshift</li>
|
||||
<li>Amazon Timestream</li>
|
||||
<li>Apache Cassandra</li>
|
||||
<li>AppDynamics</li>
|
||||
<li>Azure Data Explorer Datasource</li>
|
||||
<li>Azure Monitor</li>
|
||||
<li>CSV</li>
|
||||
<li>DB2 Datasource</li>
|
||||
<li>Databricks</li>
|
||||
<li>Datadog</li>
|
||||
<li>Dataset</li>
|
||||
<li>Druid</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>
|
||||
<ul>
|
||||
<li>Dynatrace</li>
|
||||
<li>GitHub</li>
|
||||
<li>Google BigQuery</li>
|
||||
<li>Grafana for YNAB</li>
|
||||
<li>Honeycomb</li>
|
||||
<li>Jira</li>
|
||||
<li>Mock</li>
|
||||
<li>Neo4j Datasource</li>
|
||||
<li>New Relic</li>
|
||||
<li>OPC UA (Unified Architecture)</li>
|
||||
<li>Open Distro for Elasticsearch</li>
|
||||
<li>OpenSearch</li>
|
||||
<li>OpenTSDB</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>
|
||||
<ul>
|
||||
<li>Orbit</li>
|
||||
<li>SAP HANA®</li>
|
||||
<li>Salesforce</li>
|
||||
<li>Sentry</li>
|
||||
<li>ServiceNow</li>
|
||||
<li>Snowflake</li>
|
||||
<li>Splunk</li>
|
||||
<li>Splunk Infrastructure Monitoring</li>
|
||||
<li>Sqlyze data source</li>
|
||||
<li>TDengine</li>
|
||||
<li>Vertica</li>
|
||||
<li>Wavefront</li>
|
||||
<li>X-Ray</li>
|
||||
<li>kdb+</li>
|
||||
<li>simple grpc data source</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## Limitations
|
||||
|
||||
- Panels that use frontend data sources will fail to fetch data.
|
||||
- Template variables are not supported.
|
||||
- Exemplars will be omitted from the panel.
|
||||
- Only annotations that query the `-- Grafana --` data source 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).
|
||||
@ -123,10 +123,11 @@ By hovering over a panel with the mouse you can use some shortcuts that will tar
|
||||
|
||||
- `e`: Toggle panel edit view
|
||||
- `v`: Toggle panel fullscreen view
|
||||
- `ps`: Open Panel Share Modal
|
||||
- `pd`: Duplicate Panel
|
||||
- `pr`: Remove Panel
|
||||
- `pl`: Toggle panel legend
|
||||
- `pu`: Open share panel link configuration
|
||||
- `pe`: Open share panel embed configuration
|
||||
- `ps`: Open share panel snapshot configuration
|
||||
- `pd`: Duplicate panel
|
||||
- `pr`: Remove panel
|
||||
|
||||
## Set dashboard time range
|
||||
|
||||
|
||||
@ -66,7 +66,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
||||
- [Other API]({{< relref "other/" >}})
|
||||
- [Playlists API]({{< relref "playlist/" >}})
|
||||
- [Preferences API]({{< relref "preferences/" >}})
|
||||
- [Public dashboard API]({{< relref "dashboard_public/" >}})
|
||||
- [Shared dashboards API]({{< relref "dashboard_public/" >}})
|
||||
- [Query history API]({{< relref "query_history/" >}})
|
||||
- [Service account API]({{< relref "serviceaccount/" >}})
|
||||
- [Short URL API]({{< relref "short_url/" >}})
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
aliases:
|
||||
- ../../http_api/dashboard_public/
|
||||
canonical: /docs/grafana/latest/developers/http_api/dashboard_public/
|
||||
description: Grafana Public Dashboard HTTP API
|
||||
description: Grafana Shared Dashboards HTTP API
|
||||
keywords:
|
||||
- grafana
|
||||
- http
|
||||
@ -13,7 +13,7 @@ labels:
|
||||
products:
|
||||
- enterprise
|
||||
- oss
|
||||
title: Public Dashboard HTTP API
|
||||
title: Shared Dashboards HTTP API
|
||||
refs:
|
||||
role-based-access-control-permissions:
|
||||
- pattern: /docs/grafana/
|
||||
@ -22,7 +22,7 @@ refs:
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/administration/roles-and-permissions/access-control/custom-role-actions-scopes/
|
||||
---
|
||||
|
||||
# Public Dashboard API
|
||||
# Shared Dashboards API
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
|
||||
@ -30,21 +30,21 @@ If you're running Grafana Enterprise, you'll need to have specific permissions f
|
||||
|
||||
{{% /admonition %}}
|
||||
|
||||
## Create a public dashboard
|
||||
## Create a shared dashboard
|
||||
|
||||
`POST /api/dashboards/uid/:uid/public-dashboards/`
|
||||
|
||||
Creates a new public dashboard.
|
||||
Creates a new shared dashboard.
|
||||
|
||||
**Required permissions**
|
||||
|
||||
See note in the [introduction](#public-dashboard-api) for an explanation.
|
||||
See note in the [introduction](#shared-dashboards-api) for an explanation.
|
||||
|
||||
| Action | Scope |
|
||||
| ------------------------- | -------------------------------- |
|
||||
| `dashboards.public:write` | `dashboards:uid:<dashboard UID>` |
|
||||
|
||||
**Example Request for new public dashboard**:
|
||||
**Example Request for new shared dashboard**:
|
||||
|
||||
```http
|
||||
POST /api/dashboards/uid/xCpsVuc4z/public-dashboards/ HTTP/1.1
|
||||
@ -64,10 +64,10 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
||||
|
||||
JSON Body schema:
|
||||
|
||||
- **uid** – Optional. Unique identifier when creating a public dashboard. If it's null, it will generate a new uid.
|
||||
- **uid** – Optional. Unique identifier when creating a shared dashboard. If it's null, it will generate a new uid.
|
||||
- **accessToken** – Optional. Unique access token. If it's null, it will generate a new access token.
|
||||
- **timeSelectionEnabled** – Optional. Set to `true` to enable the time picker in the public dashboard. The default value is `false`.
|
||||
- **isEnabled** – Optional. Set to `true` to enable the public dashboard. The default value is `false`.
|
||||
- **timeSelectionEnabled** – Optional. Set to `true` to enable the time picker in the shared dashboard. The default value is `false`.
|
||||
- **isEnabled** – Optional. Set to `true` to enable the shared dashboard. The default value is `false`.
|
||||
- **annotationsEnabled** – Optional. Set to `true` to show annotations. The default value is `false`.
|
||||
- **share** – Optional. Set the share mode. The default value is `public`.
|
||||
|
||||
@ -96,7 +96,7 @@ Content-Length: 78
|
||||
Status Codes:
|
||||
|
||||
- **200** – Created
|
||||
- **400** – Errors (such as invalid json, missing or invalid fields, or dashboard is public)
|
||||
- **400** – Errors (such as invalid json, missing or invalid fields, or dashboard is shared)
|
||||
- **401** – Unauthorized
|
||||
- **403** – Access denied
|
||||
- **404** – Dashboard not found
|
||||
@ -115,21 +115,21 @@ Content-Length: 107
|
||||
}
|
||||
```
|
||||
|
||||
## Update a public dashboard
|
||||
## Update a shared dashboard
|
||||
|
||||
`PATCH /api/dashboards/uid/:uid/public-dashboards/:publicDashboardUid`
|
||||
|
||||
Will update the public dashboard given the specified unique identifier (uid).
|
||||
Will update the shared dashboard given the specified unique identifier (uid).
|
||||
|
||||
**Required permissions**
|
||||
|
||||
See note in the [introduction](#public-dashboard-api) for an explanation.
|
||||
See note in the [introduction](#shared-dashboard-api) for an explanation.
|
||||
|
||||
| Action | Scope |
|
||||
| ------------------------- | -------------------------------- |
|
||||
| `dashboards.public:write` | `dashboards:uid:<dashboard UID>` |
|
||||
|
||||
**Example Request for updating a public dashboard**:
|
||||
**Example Request for updating a shared dashboard**:
|
||||
|
||||
```http
|
||||
PATCH /api/dashboards/uid/xCpsVuc4z/public-dashboards/cd56d9fd-f3d4-486d-afba-a21760e2acbe HTTP/1.1
|
||||
@ -147,8 +147,8 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
||||
|
||||
JSON Body schema:
|
||||
|
||||
- **timeSelectionEnabled** – Optional. Set to `true` to enable the time picker in the public dashboard. The default value is `false`.
|
||||
- **isEnabled** – Optional. Set to `true` to enable the public dashboard. The default value is `false`.
|
||||
- **timeSelectionEnabled** – Optional. Set to `true` to enable the time picker in the shared dashboard. The default value is `false`.
|
||||
- **isEnabled** – Optional. Set to `true` to enable the shared dashboard. The default value is `false`.
|
||||
- **annotationsEnabled** – Optional. Set to `true` to show annotations. The default value is `false`.
|
||||
- **share** – Optional. Set the share mode. The default value is `public`.
|
||||
|
||||
@ -180,7 +180,7 @@ Status Codes:
|
||||
- **400** – Errors (such as invalid json, missing or invalid fields)
|
||||
- **401** – Unauthorized
|
||||
- **403** – Access denied
|
||||
- **404** – Public dashboard not found
|
||||
- **404** – Dashboard not found
|
||||
|
||||
The error response body will have the following properties:
|
||||
|
||||
@ -196,15 +196,15 @@ Content-Length: 107
|
||||
}
|
||||
```
|
||||
|
||||
## Get public dashboard by dashboard uid
|
||||
## Get shared dashboard by dashboard uid
|
||||
|
||||
`GET /api/dashboards/uid/:uid/public-dashboards/`
|
||||
|
||||
Will return the public dashboard given the dashboard unique identifier (uid).
|
||||
Will return the shared dashboard given the dashboard unique identifier (uid).
|
||||
|
||||
**Required permissions**
|
||||
|
||||
See note in the [introduction](#public-dashboard-api) for an explanation.
|
||||
See note in the [introduction](#shared-dashboard-api) for an explanation.
|
||||
|
||||
| Action | Scope |
|
||||
| ----------------- | -------------------------------- |
|
||||
@ -245,17 +245,17 @@ Status Codes:
|
||||
- **200** – Found
|
||||
- **401** – Unauthorized
|
||||
- **403** – Access denied
|
||||
- **404** – Not found
|
||||
- **404** – Dashboard not found
|
||||
|
||||
## Delete public dashboard by dashboard uid and public dashboard uid
|
||||
## Delete shared dashboard by dashboard uid and shared dashboard uid
|
||||
|
||||
`DELETE /api/dashboards/uid/:uid/public-dashboards/:publicDashboardUid`
|
||||
|
||||
Will delete the public dashboard given the specified unique identifier (uid).
|
||||
Will delete the shared dashboard given the specified unique identifier (uid).
|
||||
|
||||
**Required permissions**
|
||||
|
||||
See note in the [introduction](#public-dashboard-api) for an explanation.
|
||||
See note in the [introduction](#shared-dashboard-api) for an explanation.
|
||||
|
||||
| Action | Scope |
|
||||
| ------------------------- | -------------------------------- |
|
||||
@ -276,13 +276,13 @@ Status Codes:
|
||||
- **401** – Unauthorized
|
||||
- **403** – Access denied
|
||||
|
||||
## Get a list of all public dashboards with pagination
|
||||
## Get a list of all shared dashboards with pagination
|
||||
|
||||
`GET /api/dashboards/public-dashboards`
|
||||
|
||||
**Required permissions**
|
||||
|
||||
See note in the [introduction](#public-dashboard-api) for an explanation.
|
||||
See note in the [introduction](#shared-dashboard-api) for an explanation.
|
||||
|
||||
| Action | Scope |
|
||||
| ----------------- | -------------------------------- |
|
||||
|
||||
@ -61,7 +61,7 @@ Grafana Enterprise adds the following features:
|
||||
- [Data source permissions]({{< relref "../administration/data-source-management#data-source-permissions" >}}) to restrict query access to specific teams and users.
|
||||
- [Data source query and resource caching]({{< relref "../administration/data-source-management#query-and-resource-caching" >}}) to temporarily store query results in Grafana to reduce data source load and rate limiting.
|
||||
- [Reporting]({{< relref "../dashboards/create-reports" >}}) to generate a PDF report from any dashboard and set up a schedule to have it emailed to whomever you choose.
|
||||
- [Export dashboard as PDF]({{< relref "../dashboards/share-dashboards-panels#export-dashboard-as-pdf" >}})
|
||||
- [Export dashboard as PDF]({{< relref "../dashboards/share-dashboards-panels#export-a-dashboard-as-pdf" >}})
|
||||
- [Custom branding]({{< relref "../setup-grafana/configure-grafana/configure-custom-branding" >}}) to customize Grafana from the brand and logo to the footer links.
|
||||
- [Usage insights]({{< relref "../dashboards/assess-dashboard-usage" >}}) to understand how your Grafana instance is used.
|
||||
- [Recorded queries]({{< relref "../administration/recorded-queries" >}}) to see trends over time for your data sources.
|
||||
|
||||
@ -2613,8 +2613,8 @@ Format: `<pageUrl> = <sectionId> <sortWeight>`
|
||||
|
||||
## [public_dashboards]
|
||||
|
||||
This section configures the [public dashboards]({{< relref "../../dashboards/dashboard-public" >}}) feature.
|
||||
This section configures the [shared dashboards](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/dashboards/share-dashboards-panels/shared-dashboards/) feature.
|
||||
|
||||
### enabled
|
||||
|
||||
Set this to `false` to disable the public dashboards feature. This prevents users from creating new public dashboards and disables existing ones.
|
||||
Set this to `false` to disable the shared dashboards feature. This prevents users from creating new shared dashboards and disables existing ones.
|
||||
|
||||
@ -112,22 +112,22 @@ The following two links are always present in the footer:
|
||||
|
||||
If you specify `footer_links` or `GF_WHITE_LABELING_FOOTER_LINKS`, then all other default links are removed from the footer, and only what is specified is included.
|
||||
|
||||
## Custom branding for public dashboards
|
||||
## Custom branding for shared dashboards
|
||||
|
||||
In addition to the customizations described below, you can customize the footer of your public dashboards.
|
||||
To customize the footer of a public dashboard, add the following section to the `grafana.ini` file.
|
||||
In addition to the customizations described below, you can customize the footer of your shared dashboards.
|
||||
To customize the footer of a shared dashboard, add the following section to the `grafana.ini` file.
|
||||
|
||||
```ini
|
||||
[white_labeling.public_dashboards]
|
||||
|
||||
# Hides the footer for the public dashboards if set to `true`.
|
||||
# Hides the footer for the shared dashboards if set to `true`.
|
||||
# example: footer_hide = "true"
|
||||
;footer_hide =
|
||||
|
||||
# Set to text shown in the footer
|
||||
;footer_text =
|
||||
|
||||
# Set to complete url to override public dashboard footer logo. Default is `grafana-logo` and will display the Grafana logo.
|
||||
# Set to complete url to override shared dashboard footer logo. Default is `grafana-logo` and will display the Grafana logo.
|
||||
# An empty value will hide the footer logo.
|
||||
;footer_logo =
|
||||
|
||||
|
||||
@ -94,7 +94,7 @@ you can use JWT authentication to authenticate the iframe.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
For Grafana Cloud, or scenarios where verifying viewer identity is not required,
|
||||
embed [public dashboards]({{< relref "../../../../dashboards/dashboard-public" >}}).
|
||||
embed [shared dashboards](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/dashboards/share-dashboards-panels/shared-dashboards/).
|
||||
{{% /admonition %}}
|
||||
|
||||
In this scenario, you will need to configure Grafana to accept a JWT
|
||||
|
||||
@ -26,7 +26,7 @@ While an image is being rendered, the PNG image is temporarily written to the fi
|
||||
|
||||
A background job runs every 10 minutes and removes temporary images. You can configure how long an image should be stored before being removed by configuring the [temp_data_lifetime]({{< relref "../configure-grafana#temp_data_lifetime" >}}) setting.
|
||||
|
||||
You can also render a PNG by hovering over the panel to display the actions menu in the top right corner, and then clicking **Share > Direct link rendered image** in the Link tab.
|
||||
You can also render a PNG by hovering over the panel to display the actions menu in the top-right corner, and then clicking **Share > Share link**. The **Render image** option is displayed in the link settings.
|
||||
|
||||
## Alerting and render limits
|
||||
|
||||
|
||||
@ -225,7 +225,7 @@ With this update, we've made the following improvements:
|
||||
|
||||
To try it out, enable the `publicDashboards` feature toggle. If you’re using Grafana Cloud, and would like to enable this feature, please contact customer support.
|
||||
|
||||
To learn more, refer to our [public dashboards documentation]({{< relref "../dashboards/dashboard-public" >}}).
|
||||
To learn more, refer to our [public dashboards documentation](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/dashboards/share-dashboards-panels/shared-dashboards/).
|
||||
|
||||
### Public dashboards insights
|
||||
|
||||
@ -255,7 +255,7 @@ This feature will have a cost by active users after being promoted into general
|
||||
|
||||
{{% /admonition %}}
|
||||
|
||||
To learn more, refer to our [public dashboards documentation]({{< relref "../dashboards/dashboard-public" >}}).
|
||||
To learn more, refer to our [public dashboards documentation](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/dashboards/share-dashboards-panels/shared-dashboards/).
|
||||
|
||||
## Authentication and authorization
|
||||
|
||||
|
||||
@ -46,7 +46,7 @@ Learn how to upload images here: https://grafana.com/docs/writers-toolkit/write/
|
||||
|
||||
_Generally available in all editions of Grafana_
|
||||
|
||||
Public dashboards allow you to share your visualizations and insights with a broader audience without the requirement of a login. You can effortlessly use our current sharing model and create a public dashboard URL to share with anyone using the generated public URL link. To learn more, refer to the [Public dashboards documentation](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/dashboards/dashboard-public/), as well as the following video demo:
|
||||
Public dashboards allow you to share your visualizations and insights with a broader audience without the requirement of a login. You can effortlessly use our current sharing model and create a public dashboard URL to share with anyone using the generated public URL link. To learn more, refer to the [Public dashboards documentation](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/dashboards/share-dashboards-panels/shared-dashboards), as well as the following video demo:
|
||||
|
||||
{{< youtube id="XHwwRCdxHMg?rel=0" >}}
|
||||
|
||||
|
||||
@ -384,7 +384,7 @@ To learn more about Grafana's strong password policy, refer to the [documentatio
|
||||
|
||||
_Generally available in Grafana Enterprise_
|
||||
|
||||
We are announcing a license change to the anonymous access feature in Grafana 11. As you may already be aware, anonymous access allows users access to Grafana without login credentials. Anonymous access was an early feature of Grafana to share dashboards; however, we recently introduced [Public Dashboards](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/dashboards/dashboard-public/) which allows you to share dashboards in a more secure manner. We also noticed that anonymous access inadvertently resulted in user licensing issues. After careful consideration, we have decided to charge for the continued use of anonymous access starting in Grafana 11.
|
||||
We are announcing a license change to the anonymous access feature in Grafana 11. As you may already be aware, anonymous access allows users access to Grafana without login credentials. Anonymous access was an early feature of Grafana to share dashboards; however, we recently introduced [Public Dashboards](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/dashboards/share-dashboards-panels/shared-dashboards) which allows you to share dashboards in a more secure manner. We also noticed that anonymous access inadvertently resulted in user licensing issues. After careful consideration, we have decided to charge for the continued use of anonymous access starting in Grafana 11.
|
||||
|
||||
**Affected Grafana versions**
|
||||
|
||||
|
||||
@ -50,7 +50,7 @@ You can now easily embed Grafana in other applications by adding a JWT token dir
|
||||
When the JWT token is passed through the request URL to Grafana, Grafana validates and authenticates the token linked to a specific user, allowing access to dashboards which that user can view.
|
||||
To see JWT URL embedding in action, see the [sample project](https://github.com/grafana/grafana-iframe-oauth-sample).
|
||||
|
||||
> **Note:** JWT URL Embedding and `allow_embedding` are not available to Grafana Cloud users. For Grafana Cloud, use the [Public Dashboards]({{< relref "../dashboards/dashboard-public" >}}) feature. To enable that, [open a ticket with our Support team](/docs/grafana-cloud/account-management/support/).
|
||||
> **Note:** JWT URL Embedding and `allow_embedding` are not available to Grafana Cloud users. For Grafana Cloud, use [public dashboards](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/dashboards/share-dashboards-panels/shared-dashboards/). To enable that, [open a ticket with our Support team](/docs/grafana-cloud/account-management/support/).
|
||||
|
||||
{{< figure src="/static/img/docs/dashboards/jwt-url-embedding-9-1.png" max-width="750px" caption="A JWT token used to embed Grafana" >}}
|
||||
|
||||
@ -156,7 +156,7 @@ The public view of a dashboard has a few restrictions:
|
||||
- The public dashboard is displayed in a read-only kiosk view.
|
||||
- The time range is fixed to the dashboard default time range.
|
||||
|
||||
To learn more, see the [documentation]({{< relref "../dashboards/dashboard-public" >}}).
|
||||
To learn more, see the [documentation](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/dashboards/share-dashboards-panels/shared-dashboards/).
|
||||
|
||||
#### Provisioning improvements for Grafana Alerting
|
||||
|
||||
|
||||
@ -95,7 +95,7 @@ External alertmanagers should now be configured as data sources using Grafana Co
|
||||
_Available in Experimental in Grafana Open Source, Enterprise, and Cloud._
|
||||
_To enable public dashboards, you must enable a feature flag or request this feature from support._
|
||||
|
||||
[Public dashboards](/docs/grafana/latest/dashboards/dashboard-public/) launched as an experimental feature in Grafana v9.1.
|
||||
[Public dashboards](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/dashboards/share-dashboards-panels/shared-dashboards) launched as an experimental feature in Grafana v9.1.
|
||||
We've received lots of great feedback on this much-anticipated feature and thank everyone who has helped us improve it.
|
||||
The team has been hard at work polishing public dashboards, and we've closed quite a few bugs related to community reports.
|
||||
If you're trying out public dashboards, let us know how it is going in the [open discussion in GitHub](https://github.com/grafana/grafana/discussions/49253).
|
||||
|
||||
@ -87,7 +87,7 @@ Annotations are now supported in public dashboards, with the exception of query
|
||||
|
||||
Note that because Public Dashboards is an experimental feature, you need to enable it in Grafana using the `publicDashboards` [feature toggle]({{< relref "../setup-grafana/configure-grafana#feature_toggles" >}}), or open a support ticket requesting public dashboards if you are a Cloud Advanced customer.
|
||||
|
||||
To learn more about public dashboards, refer to [Public dashboards]({{< relref "../dashboards/dashboard-public" >}}).
|
||||
To learn more about public dashboards, refer to [Public dashboards](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/dashboards/share-dashboards-panels/shared-dashboards/).
|
||||
|
||||
## New transformation: Partition by values
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user