Skip to content

N
nexpie-grafana-theme
Commit 1bc0cff7 by achatterjee-grafana Committed by GitHub
Options

Share panel dashboard (#30147) 

* Checking in changes.

* Change to title.

* More changes.

* More changes, removed share panel and dashboard topics from dashboards folder.

* Check in changes.

* More changes.

* Metadata and title changes.

* Update docs/sources/sharing/share-panel.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/sharing/share-panel.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/sharing/share-panel.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* removed extra space

* Update docs/sources/dashboards/_index.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/sharing/_index.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/sharing/share-dashboard.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* More changes.

* Update docs/sources/sharing/share-dashboard.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* minor change.

* Updated with correct relref link.

* Changes Snapshot to snapshot.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
parent e7c53ddd
Showing with 84 additions and 151 deletions
docs/sources/alerting/_index.md
+++
title = "Alerts"
aliases = ["/docs/grafana/latest/alerting/rules/", "/docs/grafana/latest/alerting/metrics/"]
weight = 100
weight = 110
+++
# Alerts overview
......
docs/sources/dashboards/_index.md
......@@ -42,7 +42,7 @@ Dashboards can use [templating]({{< relref "../variables/_index.md" >}}) to make
Dashboards can use [annotations]({{< relref "annotations.md" >}}) to display event data across panels. This can help correlate the time series data in the panel with other events.
Dashboards can be [shared]({{< relref "share-dashboard.md" >}}) easily in a variety of ways.
You can [share dashboards]({{< relref "../sharing/share-dashboard.md" >}}) in a variety of ways.
Dashboards can be tagged, and the dashboard picker provides quick, searchable access to all dashboards in a particular organization.
......@@ -59,4 +59,3 @@ We use a unit abstraction so that Grafana looks great on all screen sizes.
Collapse a row by clicking on the row title. If you save a dashboard with a row collapsed, then it saves in that state and does not load those graphs until you expand the row.
Use the [repeating rows]({{< relref "../variables/_index.md#repeating-rows" >}}) functionality to dynamically create or remove entire rows, which can be filled with panels, based on the template variables selected.
docs/sources/dashboards/share-dashboard.md deleted 100644 → 0
+++
title = "Share dashboard"
keywords = ["grafana", "dashboard", "documentation", "sharing"]
aliases = ["/docs/grafana/latest/reference/share_dashboard/"]
weight = 500
+++
# Share dashboard
Share a dashboard via the share icon in the top nav. This opens the share dialog where you
can get a link to the current dashboard with the current selected time range and template variables. If you have
made changes to the dashboard, make sure those are saved before sending the link. Below are ways to share a dashboard.
## Dashboard snapshot
A dashboard snapshot is an instant way to share an interactive dashboard publicly. When created, we <strong>strip sensitive data</strong> like queries
(metric, template and annotation) and panel links, leaving only the visible metric data and series names embedded into your dashboard. Dashboard
snapshots can be accessed by anyone who has the link and can reach the URL.
{{< docs-imagebox img="/img/docs/v50/share_panel_modal.png" max-width="700px" >}}
## Publish snapshots
You can publish snapshots to your local instance or to [snapshot.raintank.io](http://snapshot.raintank.io). The latter is a free service
provided by Grafana Labs, that allows you to publish dashboard snapshots to an external Grafana instance.
The same rules still apply, anyone with the link can view it. You can set an expiration time if you want the snapshot to be removed
after a certain time period.
docs/sources/dashboards/share-panel.md deleted 100644 → 0
+++
title = "Share panel"
keywords = ["grafana", "dashboard", "documentation", "sharing"]
aliases = ["/docs/grafana/latest/reference/share_panel/"]
weight = 600
+++
# Share a panel
To share a panel
1. Click a panel title to open the panel menu.
1. Click share in the panel menu to open the Share Panel dialog.
Here you have access to a link that will take you to exactly this panel with the current time range and selected template variables. Here are some of the ways you can share a panel.
## Publish snapshots
You can publish snapshots to your local instance or to [snapshot.raintank.io](http://snapshot.raintank.io). The latter is a free service provided by [Raintank](http://raintank.io), that allows you to publish dashboard snapshots to an external Grafana instance.
Anyone with the link can view it. You can optionally set an expiration time if you want the snapshot to be removed after a certain time period.
{{< docs-imagebox img="/img/docs/panels/Share_a_panel.png" max-width="700px" >}}
## Direct Link Rendered Image
You also get a link to render a .png image of the panel, which is useful if you want to share an image of the panel. For more information about the requirements and how to configure image rendering, refer to [Image rendering]({{< relref "../administration/image_rendering.md)" >}}.
Example of 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+.
## Embed Panel
You can embed a panel using an iframe on another web site. This tab will show you the html that you need to use.
> **Note:** This sharing requires [allow_embedding]({{< relref "../administration/configuration.md#allow-embedding" >}}) enabled and anonymous access, or proper configuration of the [cookie_samesite]({{< relref "../administration/configuration.md#cookie-samesite" >}}) setting.
Example:
```html
<iframe src="https://snapshot.raintank.io/dashboard-solo/snapshot/y7zwi2bZ7FcoTlB93WN7yWO4aMiz3pZb?from=1493369923321&to=1493377123321&panelId=4" width="650" height="300" frameborder="0"></iframe>
```
Below there should be an interactive Grafana graph embedded in an iframe:
<iframe src="https://snapshot.raintank.io/dashboard-solo/snapshot/y7zwi2bZ7FcoTlB93WN7yWO4aMiz3pZb?from=1493369923321&to=1493377123321&panelId=4" width="650" height="300" frameborder="0"></iframe>
#### Export Panel Data
{{< docs-imagebox img="/img/docs/v50/export_panel_data.png" max-width="500px" >}}
The submenu for a panel can be found by clicking on the title of a panel and then on the More submenu.
This menu contains two options for exporting data:
- The panel JSON (the specification and not the data) can be exported or updated via the panel context menu.
- Panel data can be exported in the CSV format for Table and Graph Panels.
docs/sources/sharing/_index.md
+++
title = "Sharing"
weight = 4
draft = "true"
weight = 85
+++
# Sharing
# Sharing dashboards and panels
This section contains pages that will help you share Grafana visualizations.
\ No newline at end of file
Grafana allows 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)
Refer to [Share a dashboard]({{< relref "share-dashboard.md" >}}) and [Share a panel]({{< relref "share-panel.md" >}}) for more information.
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. You can enable [anonymous access]({{< relref "../auth/overview.md" >}}) by yourself in Grafana OSS. To enable anonymous access on a Grafana Cloud instance, contact your Customer Support.
When you share a panel or dashboard as a snapshot, a snapshot (of the panel or the dashboard at that moment in time) is publicly available on the web. Anyone with a link to it can access it. Since snapshots do not need any authorization to view, Grafana strips information related to the account it came from, as well as any sensitive data from the snapshot.
docs/sources/sharing/share-dashboard.md
+++
title = "Share a Dashboard"
title = "Share a dashboard"
keywords = ["grafana", "dashboard", "documentation", "sharing"]
aliases = ["/docs/grafana/latest/dashboards/share-dashboard/","/docs/grafana/latest/reference/share_dashboard/"]
weight = 6
draft = "true"
+++
# Share a dashboard
Share a dashboard via the share icon in the top nav. This opens the share dialog where you
can get a link to the current dashboard with the current selected time range and template variables. If you have
made changes to the dashboard, make sure those are saved before sending the link. Below are ways to share a dashboard.
You can share a dashboard as a direct link or as a snapshot. You can also export a dashboard. If you have made changes to the dashboard, verify those changes are saved before sharing.
## Dashboard snapshot
To share a dashboard:
A dashboard snapshot is an instant way to share an interactive dashboard publicly. When created, we <strong>strip sensitive data</strong> like queries
(metric, template and annotation) and panel links, leaving only the visible metric data and series names embedded into your dashboard. Dashboard
snapshots can be accessed by anyone who has the link and can reach the URL.
1. Go to the home page of your Grafana instance.
1. Click on the share icon in the top navigation. The share dialog opens and shows the Link tab.
{{< docs-imagebox img="/img/docs/v50/share_panel_modal.png" max-width="700px" >}}
## Use direct link
The Link tab has the current time range, template variables and theme selected by default. You can optionally select a shortened URL to share.
To share a direct link:
1. Click **Copy**. This 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 snapshots
A dashboard snapshot shares an interactive dashboard publicly. Grafana strips sensitive data like queries
(metric, template and annotation) and panel links, leaving only the visible metric data and series names embedded into your dashboard. Dashboard snapshots can be accessed by anyone with the link.
You can publish snapshots to your local instance or to [snapshot.raintank.io](http://snapshot.raintank.io). The latter is a free service
provided by [Raintank](http://raintank.io), that allows you to publish dashboard snapshots to an external Grafana instance.
The same rules still apply, anyone with the link can view it. You can set an expiration time if you want the snapshot to be removed
after a certain time period.
provided by Grafana Labs that allows you to publish dashboard snapshots to an external Grafana instance. The same rules still apply: anyone with the link can view it. You can set an expiration time if you want the snapshot removed after a certain time period.
{{< docs-imagebox img="/img/docs/v50/share_panel_modal.png" max-width="700px" >}}
To publish a snapshot:
1. Click on **Local Snapshot** or **Publish to snapshot.raintank.io**. This generates the link of the snapshot.
1. Copy the snapshot link, and share it either within your organization or publicly on the web.
In case you created a snapshot by mistake, click **delete snapshot** to remove the snapshot from your Grafana instance.
## Export dashboard
Grafana dashboards can easily be exported and imported. For more information, refer to [Export and import dashboards]({{< relref "../dashboards/export-import.md" >}}).
docs/sources/sharing/share-panel.md
+++
title = "Share a Panel"
title = "Share a panel"
keywords = ["grafana", "dashboard", "documentation", "sharing"]
aliases = ["/docs/grafana/latest/dashboards/share-dashboard/","/docs/grafana/latest/reference/share_panel/"]
weight = 6
draft = "true"
+++
# Share a panel
To share a panel
You can share a panel as a direct link, as a snapshot or as an embedded link.
1. Click a panel title to open the panel menu.
1. Click share in the panel menu to open the Share Panel dialog.
Here you have access to a link that will take you to exactly this panel with the current time range and selected template variables. Here are some of the ways you can share a panel.
To share a panel:
## Publish snapshots
1. Click a panel title to open the panel menu.
1. Click **Share**. The share dialog opens and shows the Link tab.
You can publish snapshots to your local instance or to [snapshot.raintank.io](http://snapshot.raintank.io). The latter is a free service provided by [Raintank](http://raintank.io), that allows you to publish dashboard snapshots to an external Grafana instance.
## Use direct link
Anyone with the link can view it. You can optionally set an expiration time if you want the snapshot to be removed after a certain time period.
The Link tab has the current time range, template variables and theme selected by default. You can optionally enable a shortened URL to share.
{{< docs-imagebox img="/img/docs/panels/Share_a_panel.png" max-width="700px" >}}
To share a direct link:
## Direct Link Rendered Image
1. Click **Copy**. This 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.
You also get a link to render a PNG image of the panel. Useful if you want to share an image of the panel. For more information about the requirements and how to configure image rendering, refer to [image rendering](/administration/image_rendering/).
For more information, refer to the topic [Image rendering]({{< relref "../administration/image_rendering.md)" >}}).
Example of a link to a server-side rendered PNG:
Here is an example of 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 snapshots
#### Query String Parameters For Server-Side Rendered Images
A panel snapshot shares an interactive panel publicly. Grafana strips sensitive data leaving only the visible metric data and series names embedded into your dashboard. Panel snapshots can be accessed by anyone with the link.
- **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.
You can publish snapshots to your local instance or to [snapshot.raintank.io](http://snapshot.raintank.io). The latter is a free service provided by [Raintank](http://raintank.io), that allows you to publish dashboard snapshots to an external Grafana instance. You can optionally set an expiration time if you want the snapshot to be removed after a certain time period.
## Embed Panel
To publish a snapshot:
You can embed a panel using an iframe on another web site. This tab will show you the html that you need to use.
1. In the Share Panel dialog, click **Snapshot** to open the tab.
1. Click on **Local Snapshot** or **Publish to snapshot.raintank.io**. This generates the link of the snapshot.
1. Copy the snapshot link, and share it either within your organization or publicly on the web.
If you created a snapshot by mistake, click **delete snapshot** to remove the snapshot from your Grafana instance.
> **Note:** This sharing requires [allow_embedding]({{< relref "../administration/configuration.md#allow-embedding" >}}) enabled and anonymous access, or proper configuration of the [cookie_samesite]({{< relref "../administration/configuration.md#cookie-samesite" >}}) setting.
## Embed panel
Example:
You can embed a panel using an iframe on another web site. Unless anonymous access permission is enabled, the viewer must be signed into Grafana to view the graph.
Here is an example of the HTML code:
```html
<iframe src="https://snapshot.raintank.io/dashboard-solo/snapshot/y7zwi2bZ7FcoTlB93WN7yWO4aMiz3pZb?from=1493369923321&to=1493377123321&panelId=4" width="650" height="300" frameborder="0"></iframe>
```
Below there should be an interactive Grafana graph embedded in an iframe:
The result is an interactive Grafana graph embedded in an iframe:
<iframe src="https://snapshot.raintank.io/dashboard-solo/snapshot/y7zwi2bZ7FcoTlB93WN7yWO4aMiz3pZb?from=1493369923321&to=1493377123321&panelId=4" width="650" height="300" frameborder="0"></iframe>
#### Export Panel Data
{{< docs-imagebox img="/img/docs/v50/export_panel_data.png" max-width="500px" >}}
The submenu for a panel can be found by clicking on the title of a panel and then on the More submenu.
This menu contains two options for exporting data:
- The panel JSON (the specification and not the data) can be exported or updated via the panel context menu.
- Panel data can be exported in the CSV format for Table and Graph Panels.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment