mirror of https://github.com/grafana/grafana
refactors all dashboard and linking content (#52005)
Christopher Moyer
3 years ago
committed by
GitHub
parent
0a2a370b77
commit
94175a801a
@ -1,31 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/linking/ |
||||
title: Linking |
||||
weight: 120 |
||||
--- |
||||
|
||||
# Linking overview |
||||
|
||||
You can use links to navigate between commonly-used dashboards or to connect others to your visualizations. Links let you create shortcuts to other dashboards, panels, and even external websites. |
||||
|
||||
Grafana supports dashboard links, panel links, and data links. Dashboard links are displayed at the top of the dashboard. Panel links are accessible by clicking an icon on the top left corner of the panel. |
||||
|
||||
## Which link should you use? |
||||
|
||||
Start by figuring out how you're currently navigating between dashboards. If you're often jumping between a set of dashboards and struggling to find the same context in each, links can help optimize your workflow. |
||||
|
||||
The next step is to figure out which link type is right for your workflow. Even though all the link types in Grafana are used to create shortcuts to other dashboards or external websites, they work in different contexts. |
||||
|
||||
- If the link relates to most if not all of the panels in the dashboard, use [dashboard links]({{< relref "dashboard-links/" >}}). |
||||
- If you want to drill down into specific panels, use [panel links]({{< relref "panel-links/" >}}). |
||||
- If you want to link to an external site, you can use either a dashboard link or a panel link. |
||||
- If you want to drill down into a specific series, or even a single measurement, use [data links]({{< relref "data-links/" >}}). |
||||
|
||||
## Controlling time range using the URL |
||||
|
||||
You can control the time range of a panel or dashboard by providing following query parameters in dashboard URL: |
||||
|
||||
- `from` - defines lower limit of the time range, specified in ms epoch |
||||
- `to` - defines upper limit of the time range, specified in ms epoch |
||||
- `time` and `time.window` - defines a time range from `time-time.window/2` to `time+time.window/2`. Both params should be specified in ms. For example `?time=1500000000000&time.window=10000` will result in 10s time range from 1499999995000 to 1500000005000 |
||||
@ -1,62 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/linking/data-link-variables/ |
||||
- /docs/grafana/latest/variables/url-variables/ |
||||
- /docs/grafana/latest/variables/variable-types/url-variables/ |
||||
keywords: |
||||
- grafana |
||||
- url variables |
||||
- documentation |
||||
- variables |
||||
- data link |
||||
title: URL variables |
||||
weight: 400 |
||||
--- |
||||
|
||||
# Data link variables |
||||
|
||||
You can use variables in data links to refer to series fields, labels, and values. For more information about data links, refer to [Data links]({{< relref "data-links/" >}}). |
||||
|
||||
To see a list of available variables, type `$` in the data link **URL** field to see a list of variables that you can use. |
||||
|
||||
> **Note:** These variables changed in 6.4 so if you have an older version of Grafana, then use the version picker to select docs for an older version of Grafana. |
||||
|
||||
You can also use template variables in your data links URLs, refer to [Templates and variables]({{< relref "../variables/" >}}) for more information on template variables. |
||||
|
||||
## Time range panel variables |
||||
|
||||
These variables allow you to include the current time range in the data link URL. |
||||
|
||||
- `__url_time_range` - current dashboard's time range (i.e. `?from=now-6h&to=now`) |
||||
- `$__from and $__to` - For more information, refer to [Global variables]({{< relref "../variables/variable-types/global-variables/#__from-and-__to" >}}). |
||||
|
||||
## Series variables |
||||
|
||||
Series specific variables are available under `__series` namespace: |
||||
|
||||
- `__series.name` - series name to the URL |
||||
|
||||
## Field variables |
||||
|
||||
Field-specific variables are available under `__field` namespace: |
||||
|
||||
- `__field.name` - the name of the field |
||||
- `__field.labels.<LABEL>` - label's value to the URL. If your label contains dots, then use `__field.labels["<LABEL>"]` syntax. |
||||
|
||||
## Value variables |
||||
|
||||
Value-specific variables are available under `__value` namespace: |
||||
|
||||
- `__value.time` - value's timestamp (Unix ms epoch) to the URL (i.e. `?time=1560268814105`) |
||||
- `__value.raw` - raw value |
||||
- `__value.numeric` - numeric representation of a value |
||||
- `__value.text` - text representation of a value |
||||
- `__value.calc` - calculation name if the value is result of calculation |
||||
|
||||
## Template variables |
||||
|
||||
When linking to another dashboard that uses template variables, select variable values for whoever clicks the link. |
||||
|
||||
`${myvar:queryparam}` - where `myvar` is a name of the template variable that matches one in the current dashboard that you want to use. |
||||
|
||||
If you want to add all of the current dashboard's variables to the URL, then use `__all_variables`. |
||||
@ -1,54 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/linking/data-links/ |
||||
- /docs/grafana/latest/reference/datalinks/ |
||||
keywords: |
||||
- grafana |
||||
- data links |
||||
- documentation |
||||
- playlist |
||||
title: Data links |
||||
--- |
||||
|
||||
# Data links |
||||
|
||||
Data links allow you to provide more granular context to your links. You can create links that include the series name or even the value under the cursor. For example, if your visualization showed four servers, you could add a data link to one or two of them. |
||||
|
||||
The link itself is accessible in different ways depending on the visualization. For the Graph you need to click on a data point or line, for a panel like |
||||
Stat, Gauge, or Bar Gauge you can click anywhere on the visualization to open the context menu. |
||||
|
||||
You can use variables in data links to send people to a detailed dashboard with preserved data filters. For example, you could use variables to specify a time range, series, and variable selection. For more information, refer to [Data link variables]({{< relref "data-link-variables/" >}}). |
||||
|
||||
## Typeahead suggestions |
||||
|
||||
When creating or updating a data link, press Cmd+Space or Ctrl+Space on your keyboard to open the typeahead suggestions to more easily add variables to your URL. |
||||
|
||||
{{< figure src="/static/img/docs/data_link_typeahead.png" max-width= "800px" >}} |
||||
|
||||
## Add a data link |
||||
|
||||
1. Hover your cursor over the panel that you want to add a link to and then press `e`. Or click the dropdown arrow next to the panel title and then click **Edit**. |
||||
1. On the Field tab, scroll down to the Data links section. |
||||
1. Expand Data links and then click **Add link**. |
||||
1. Enter a **Title**. **Title** is a human-readable label for the link that will be displayed in the UI. |
||||
1. Enter the **URL** you want to link to. |
||||
|
||||
You can even add one of the template variables defined in the dashboard. Click in the **URL** field and then type `$` or press Ctrl+Space or Cmd+Space to see a list of available variables. By adding template variables to your panel link, the link sends the user to the right context, with the relevant variables already set. For more information, refer to [Data link variables]({{< relref "data-link-variables/" >}}). |
||||
|
||||
1. If you want the link to open in a new tab, then select **Open in a new tab**. |
||||
1. Click **Save** to save changes and close the window. |
||||
1. Click **Save** in the upper right to save your changes to the dashboard. |
||||
|
||||
## Update a data link |
||||
|
||||
1. On the Field tab, find the link that you want to make changes to. |
||||
1. Click the Edit (pencil) icon to open the Edit link window. |
||||
1. Make any necessary changes. |
||||
1. Click **Save** to save changes and close the window. |
||||
1. Click **Save** in the upper right to save your changes to the dashboard. |
||||
|
||||
## Delete a data link |
||||
|
||||
1. On the Field tab, find the link that you want to delete. |
||||
1. Click the **X** icon next to the link you want to delete. |
||||
1. Click **Save** in the upper right to save your changes to the dashboard. |
||||
@ -1,39 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/features/navigation-links/ |
||||
- /docs/grafana/latest/linking/linking-overview/ |
||||
keywords: |
||||
- grafana |
||||
- linking |
||||
- create links |
||||
- link panels |
||||
- link dashboards |
||||
- navigate |
||||
title: Linking overview |
||||
weight: 100 |
||||
--- |
||||
|
||||
# Linking overview |
||||
|
||||
You can use links to navigate between commonly-used dashboards or to connect others to your visualizations. Links let you create shortcuts to other dashboards, panels, and even external websites. |
||||
|
||||
Grafana supports dashboard links, panel links, and data links. Dashboard links are displayed at the top of the dashboard. Panel links are accessible by clicking an icon on the top left corner of the panel. |
||||
|
||||
## Which link should you use? |
||||
|
||||
Start by figuring out how you're currently navigating between dashboards. If you're often jumping between a set of dashboards and struggling to find the same context in each, links can help optimize your workflow. |
||||
|
||||
The next step is to figure out which link type is right for your workflow. Even though all the link types in Grafana are used to create shortcuts to other dashboards or external websites, they work in different contexts. |
||||
|
||||
- If the link relates to most if not all of the panels in the dashboard, use [dashboard links]({{< relref "dashboard-links/" >}}). |
||||
- If you want to drill down into specific panels, use [panel links]({{< relref "panel-links/" >}}). |
||||
- If you want to link to an external site, you can use either a dashboard link or a panel link. |
||||
- If you want to drill down into a specific series, or even a single measurement, use [data links]({{< relref "data-links/" >}}). |
||||
|
||||
## Controlling time range using the URL |
||||
|
||||
You can control the time range of a panel or dashboard by providing following query parameters in dashboard URL: |
||||
|
||||
- `from` - defines lower limit of the time range, specified in ms epoch |
||||
- `to` - defines upper limit of the time range, specified in ms epoch |
||||
- `time` and `time.window` - defines a time range from `time-time.window/2` to `time+time.window/2`. Both params should be specified in ms. For example `?time=1500000000000&time.window=10000` will result in 10s time range from 1499999995000 to 1500000005000 |
||||
@ -1,52 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/features/navigation-links/ |
||||
- /docs/grafana/latest/linking/panel-links/ |
||||
description: '' |
||||
keywords: |
||||
- grafana |
||||
- linking |
||||
- create links |
||||
- link panels |
||||
- link dashboards |
||||
- navigate |
||||
title: Panel links |
||||
weight: 300 |
||||
--- |
||||
|
||||
# Panel links |
||||
|
||||
{{< docs/shared "panels/panel-links-intro.md" >}} |
||||
|
||||
Click the icon on the top left corner of a panel to see available panel links. |
||||
|
||||
<img class="no-shadow" src="/static/img/docs/linking/panel-links.png" width="500px"> |
||||
|
||||
## Add a panel link |
||||
|
||||
1. Hover your cursor over the panel that you want to add a link to and then press `e`. Or click the dropdown arrow next to the panel title and then click **Edit**. |
||||
1. On the Panel tab, scroll down to the Links section. |
||||
1. Expand Links and then click **Add link**. |
||||
1. Enter a **Title**. **Title** is a human-readable label for the link that will be displayed in the UI. |
||||
1. Enter the **URL** you want to link to. |
||||
You can even add one of the template variables defined in the dashboard. Press Ctrl+Space or Cmd+Space and click in the **URL** field to see the available variables. By adding template variables to your panel link, the link sends the user to the right context, with the relevant variables already set. You can also use time variables: |
||||
- `from` - Defines the lower limit of the time range, specified in ms epoch. |
||||
- `to` - Defines the upper limit of the time range, specified in ms epoch. |
||||
- `time` and `time.window` - Define a time range from `time-time.window/2` to `time+time.window/2`. Both params should be specified in ms. For example `?time=1500000000000&time.window=10000` will result in 10s time range from 1499999995000 to 1500000005000. |
||||
1. If you want the link to open in a new tab, then select **Open in a new tab**. |
||||
1. Click **Save** to save changes and close the window. |
||||
1. Click **Save** in the upper right to save your changes to the dashboard. |
||||
|
||||
## Update a panel link |
||||
|
||||
1. On the Panel tab, find the link that you want to make changes to. |
||||
1. Click the Edit (pencil) icon to open the Edit link window. |
||||
1. Make any necessary changes. |
||||
1. Click **Save** to save changes and close the window. |
||||
1. Click **Save** in the upper right to save your changes to the dashboard. |
||||
|
||||
## Delete a panel link |
||||
|
||||
1. On the Panel tab, find the link that you want to delete. |
||||
1. Click the **X** icon next to the link you want to delete. |
||||
1. Click **Save** in the upper right to save your changes to the dashboard. |
||||
@ -0,0 +1,114 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/linking/data-link-variables/ |
||||
- /docs/grafana/latest/variables/url-variables/ |
||||
- /docs/grafana/latest/variables/variable-types/url-variables/ |
||||
- /docs/grafana/latest/linking/data-links/ |
||||
- /docs/grafana/latest/reference/datalinks/ |
||||
- /docs/grafana/latest/panels/configure-data-links/ |
||||
keywords: |
||||
- grafana |
||||
- url variables |
||||
- variables |
||||
- data link |
||||
- documentation |
||||
- playlist |
||||
title: Configure data links |
||||
menuTitle: Configure data links |
||||
weight: 400 |
||||
--- |
||||
|
||||
# Configure data links |
||||
|
||||
You can use data link variables or data links to create links between panels. |
||||
|
||||
## Data link variables |
||||
|
||||
You can use variables in data links to refer to series fields, labels, and values. For more information about data links, refer to [Data links]({{< relref "#data-links" >}}). |
||||
|
||||
To see a list of available variables, type `$` in the data link **URL** field to see a list of variables that you can use. |
||||
|
||||
> **Note:** These variables changed in 6.4 so if you have an older version of Grafana, then use the version picker to select docs for an older version of Grafana. |
||||
|
||||
You can also use template variables in your data links URLs, refer to [Templates and variables]({{< relref "../../variables/" >}}) for more information on template variables. |
||||
|
||||
## Time range panel variables |
||||
|
||||
These variables allow you to include the current time range in the data link URL. |
||||
|
||||
- `__url_time_range` - current dashboard's time range (i.e. `?from=now-6h&to=now`) |
||||
- `$__from and $__to` - For more information, refer to [Global variables]({{< relref "../../variables/variable-types/global-variables/#__from-and-__to" >}}). |
||||
|
||||
## Series variables |
||||
|
||||
Series specific variables are available under `__series` namespace: |
||||
|
||||
- `__series.name` - series name to the URL |
||||
|
||||
## Field variables |
||||
|
||||
Field-specific variables are available under `__field` namespace: |
||||
|
||||
- `__field.name` - the name of the field |
||||
- `__field.labels.<LABEL>` - label's value to the URL. If your label contains dots, then use `__field.labels["<LABEL>"]` syntax. |
||||
|
||||
## Value variables |
||||
|
||||
Value-specific variables are available under `__value` namespace: |
||||
|
||||
- `__value.time` - value's timestamp (Unix ms epoch) to the URL (i.e. `?time=1560268814105`) |
||||
- `__value.raw` - raw value |
||||
- `__value.numeric` - numeric representation of a value |
||||
- `__value.text` - text representation of a value |
||||
- `__value.calc` - calculation name if the value is result of calculation |
||||
|
||||
## Template variables |
||||
|
||||
When linking to another dashboard that uses template variables, select variable values for whoever clicks the link. |
||||
|
||||
`${myvar:queryparam}` - where `myvar` is a name of the template variable that matches one in the current dashboard that you want to use. |
||||
|
||||
If you want to add all of the current dashboard's variables to the URL, then use `__all_variables`. |
||||
|
||||
## Data links |
||||
|
||||
Data links allow you to provide more granular context to your links. You can create links that include the series name or even the value under the cursor. For example, if your visualization showed four servers, you could add a data link to one or two of them. |
||||
|
||||
The link itself is accessible in different ways depending on the visualization. For the Graph you need to click on a data point or line, for a panel like |
||||
Stat, Gauge, or Bar Gauge you can click anywhere on the visualization to open the context menu. |
||||
|
||||
You can use variables in data links to send people to a detailed dashboard with preserved data filters. For example, you could use variables to specify a time range, series, and variable selection. For more information, refer to [Data link variables]({{< relref "#data-link-variables" >}}). |
||||
|
||||
### Typeahead suggestions |
||||
|
||||
When creating or updating a data link, press Cmd+Space or Ctrl+Space on your keyboard to open the typeahead suggestions to more easily add variables to your URL. |
||||
|
||||
{{< figure src="/static/img/docs/data_link_typeahead.png" max-width= "800px" >}} |
||||
|
||||
### Add a data link |
||||
|
||||
1. Hover your cursor over the panel that you want to add a link to and then press `e`. Or click the dropdown arrow next to the panel title and then click **Edit**. |
||||
1. On the Field tab, scroll down to the Data links section. |
||||
1. Expand Data links and then click **Add link**. |
||||
1. Enter a **Title**. **Title** is a human-readable label for the link that will be displayed in the UI. |
||||
1. Enter the **URL** you want to link to. |
||||
|
||||
You can even add one of the template variables defined in the dashboard. Click in the **URL** field and then type `$` or press Ctrl+Space or Cmd+Space to see a list of available variables. By adding template variables to your panel link, the link sends the user to the right context, with the relevant variables already set. For more information, refer to [Data link variables]({{< relref "#data-link-variables" >}}). |
||||
|
||||
1. If you want the link to open in a new tab, then select **Open in a new tab**. |
||||
1. Click **Save** to save changes and close the window. |
||||
1. Click **Save** in the upper right to save your changes to the dashboard. |
||||
|
||||
### Update a data link |
||||
|
||||
1. On the Field tab, find the link that you want to make changes to. |
||||
1. Click the Edit (pencil) icon to open the Edit link window. |
||||
1. Make any necessary changes. |
||||
1. Click **Save** to save changes and close the window. |
||||
1. Click **Save** in the upper right to save your changes to the dashboard. |
||||
|
||||
### Delete a data link |
||||
|
||||
1. On the Field tab, find the link that you want to delete. |
||||
1. Click the **X** icon next to the link you want to delete. |
||||
1. Click **Save** in the upper right to save your changes to the dashboard. |
||||
@ -1,13 +0,0 @@ |
||||
--- |
||||
aliases: |
||||
- /docs/grafana/latest/panels/working-with-panels/add-link-to-panel/ |
||||
- /docs/sources/panels/working-with-panels/add-link-to-panel/ |
||||
title: Add a link to a panel |
||||
weight: 60 |
||||
--- |
||||
|
||||
# Add a link to a panel |
||||
|
||||
{{< docs/shared "panels/panel-links-intro.md" >}} |
||||
|
||||
For more information, refer to [Panel links]({{< relref "../../linking/panel-links/" >}}). |
||||
Loading…
Reference in new issue