Files
Isabel Matwawana 6fb1da42bf Docs: add xychart to panel config docs (#85615)
* Added xy chart to panel config docs

* Fixed typo
2024-04-04 17:06:20 -04:00

13 KiB

aliases keywords labels menuTitle title description weight
../linking/data-link-variables/
../linking/data-links/
../panels/configure-data-links/
../reference/datalinks/
../variables/url-variables/
../variables/variable-types/url-variables/
grafana
url variables
variables
data link
documentation
playlist
products
cloud
enterprise
oss
Configure data links Configure data links Configure data links to create links between dashboards and link to external resources 80

Configure 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 shows four servers, you can add a data link to one or two of them. You can also link panels using data links.

The link itself is accessible in different ways depending on the visualization. For the time series visualization you need to click a data point or line:

Time series visualization with a data link displayed

For visualizations like stat, gauge, or bar gauge you can click anywhere on the visualization to open the context menu:

Stat visualization with a data link displayed

If there's only one data link in the visualization, clicking anywhere on the visualization opens the link rather than the context menu.

Supported visualizations

You can configure data links for the following visualizations:

[Bar chart][bar chart] [Heatmap][heatmap] [Status history][status history]
[Bar gauge][bar gauge] [Histogram][histogram] [Table][table]
[Candlestick][candlestick] [Pie chart][pie chart] [Time series][time series]
[Canvas][canvas] [Stat][stat] [Trend][trend]
[Gauge][gauge] [State timeline][state timeline] [XY chart][xy chart]
[Geomap][geomap]

Variables in data links let you send people to a detailed dashboard with preserved data filters. For example, you could use variables to specify a label, time range, series, or variable selection.

To see a list of available variables, enter $ in the data link URL field.

{{% admonition type="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. {{% /admonition %}}

Azure Monitor, [CloudWatch][], and [Google Cloud Monitoring][] have pre-configured data links called deep links.

You can also use template variables in your data links URLs. For more information, refer to [Templates and variables][].

Time range panel variables

These variables allow you to include the current time range in the data link URL:

Variable Description
__url_time_range Current dashboard's time range (for example, ?from=now-6h&to=now)
__from For more information, refer to [Global variables][].
__to For more information, refer to [Global variables][].

When you create data links using time range variables like __url_time_range in the URL, you have to form the query parameter syntax yourself; that is, you must format the URL by appending query parameters using the question mark (?) and ampersand (&) syntax. These characters aren't automatically generated.

Series variables

Series-specific variables are available under __series namespace:

Variable Description
__series.name Series name to the URL

Field variables

Field-specific variables are available under __field namespace:

Variable Description
__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:

Variable Description
__value.time Value's timestamp (Unix ms epoch) to the URL (for example, ?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

Using value-specific variables in data links can show different results depending on the set option of Tooltip mode.

When you create data links using time range variables like __value.time in the URL, you have to form the query parameter syntax yourself; that is, you must add the question mark (?) and ampersand (&). These characters aren't automatically generated.

Data variables

To access values and labels from other fields use:

Variable Description
__data.fields[i] Value of field i (on the same row)
__data.fields["NameOfField"] Value of field using name instead of index
__data.fields["NameOfField"] Value of field using name instead of index
__data.fields[1].labels.cluster Access labels of another field

Template variables

When linking to another dashboard that uses template variables, select variable values for whoever clicks the link.

${var-myvar:queryparam} - where var-myvar is the name of the template variable that matches one in the current dashboard that you want to use.

Variable state Result in the created URL
selected one value var-myvar=value1
selected multiple values var-myvar=value1&var-myvar=value2
selected All var-myvar=All

If you want to add all of the current dashboard's variables to the URL, then use ${__all_variables}.

  1. Navigate to the panel to which you want to add the data link.

  2. Hover over any part of the panel to display the menu icon in the upper-right corner.

  3. Click the menu icon and select Edit to open the panel editor.

  4. In the panel edit pane, scroll down to the Data links section and expand it.

  5. Click Add link.

  6. In the dialog box that opens, enter a Title. This is a human-readable label for the link, which will be displayed in the UI.

  7. Enter the URL or variable to which you want to link.

    To add a data link variable, click in the URL field and enter $ or press Ctrl+Space or Cmd+Space to see a list of available variables.

  8. If you want the link to open in a new tab, then toggle the Open in a new tab switch.

  9. Click Save to save changes and close the dialog box.

  10. Click Apply to see your changes in the dashboard.

  11. Click the Save dashboard icon to save your changes to the dashboard.

{{% docs/reference %}} [bar chart]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/bar-chart" [bar chart]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/bar-chart"

[bar gauge]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/bar-gauge" [bar gauge]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/bar-gauge"

[candlestick]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/candlestick" [candlestick]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/candlestick"

[canvas]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/canvas" [canvas]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/canvas"

[gauge]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/gauge" [gauge]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/gauge"

[geomap]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/geomap" [geomap]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/geomap"

[heatmap]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/heatmap" [heatmap]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/heatmap"

[histogram]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/histogram" [histogram]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/histogram"

[pie chart]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/pie-chart" [pie chart]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/pie-chart"

[stat]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/stat" [stat]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/stat"

[state timeline]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/state-timeline" [state timeline]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/state-timeline"

[status history]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/status-history" [status history]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/status-history"

[table]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/table" [table]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/table"

[time series]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/time-series" [time series]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/time-series"

[trend]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/trend" [trend]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/trend"

[xy chart]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/xy-chart" [xy chart]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/xy-chart"

[Cloudwatch]: "/docs/grafana/ -> /docs/grafana//datasources/aws-cloudwatch/query-editor#deep-link-grafana-panels-to-the-cloudwatch-console-1" [Cloudwatch]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/connect-externally-hosted/data-sources/aws-cloudwatch/query-editor#deep-link-grafana-panels-to-the-cloudwatch-console-1"

[Google Cloud Monitoring]: "/docs/grafana/ -> /docs/grafana//datasources/google-cloud-monitoring/query-editor#deep-link-from-grafana-panels-to-the-google-cloud-console-metrics-explorer" [Google Cloud Monitoring]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/connect-externally-hosted/data-sources/google-cloud-monitoring/query-editor#deep-link-from-grafana-panels-to-the-google-cloud-console-metrics-explorer"

[Templates and variables]: "/docs/grafana/ -> /docs/grafana//dashboards/variables" [Templates and variables]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/dashboards/variables"

[Global variables]: "/docs/grafana/ -> /docs/grafana//dashboards/variables/add-template-variables#**from-and-**to" [Global variables]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/dashboards/variables/add-template-variables#**from-and-**to" {{% /docs/reference %}}