Documentation

Use and manage variables

This page documents an earlier version of InfluxDB. InfluxDB v2.6 is the latest stable version. View this page in the v2.6 documentation.

Dashboard variables let you alter specific components of cells’ queries without having to edit the queries, making it easy to interact with your dashboard cells and explore your data.

Variables are scoped by organization.

Use dashboard variables

Both predefined dashboard variables and custom dashboard variables are stored in a v record associated with each dashboard. Reference each variable using dot-notation (e.g. v.variableName).

from(bucket: v.bucket)
    |> range(start: v.timeRangeStart, stop: v.timeRangeStop)
    |> filter(fn: (r) => r._measurement == v.measurement and r._field == v.field)
    |> aggregateWindow(every: v.windowPeriod, fn: mean)

When building Flux queries for dashboard cells, view available dashboard variables in the Variables tab next to the Functions tab.

Click a variable name to add it to your query and select a value from the Value dropdown.

When you apply a variable to your dashboard, &vars[variable_name]=value is appended to the URL so you can share the link with the variables included.

Predefined dashboard variables

The InfluxDB user interface (UI) provides the following predefined dashboard variables:

v.timeRangeStart

Specifies the beginning of the queried time range. This variable is typically used to define the start parameter of the range() function.

The Time Range selector defines the value of this variable.

v.timeRangeStop

Specifies the end of the queried time range. This variable is typically used to define the stop parameter of the range() function.

The Time Range selector defines the value of this variable. It defaults to now.

v.windowPeriod

Specifies the period of windowed data. This variable is typically used to define the every or period parameters of the window() function in data aggregation operations.

The value of this variable is calculated by analyzing the duration of the Flux query it is used within. Queries that fetch data from a longer time range will have a larger v.windowPeriod duration.

Custom dashboard variables

Create, manage, and use custom dashboard variables in the InfluxDB user interface (UI).


Was this page helpful?

Thank you for your feedback!


Set your InfluxDB URL

Linux Package Signing Key Rotation

All signed InfluxData Linux packages have been resigned with an updated key. If using Linux, you may need to update your package configuration to continue to download and verify InfluxData software packages.

For more information, see the Linux Package Signing Key Rotation blog post.

InfluxDB Cloud backed by InfluxDB IOx

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by IOx, this is the correct documentation.

If powered by TSM, see the TSM-based InfluxDB Cloud documentation.

InfluxDB Cloud backed by InfluxDB TSM

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine which enables nearly unlimited series cardinality and SQL query support. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by TSM, this is the correct documentation.

If powered by IOx, see the IOx-based InfluxDB Cloud documentation.

State of the InfluxDB Cloud (IOx) documentation

The new documentation for InfluxDB Cloud backed by InfluxDB IOx is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.