Documentation

Use and manage variables

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!


Introducing InfluxDB Clustered

A highly available InfluxDB 3.0 cluster on your own infrastructure.

InfluxDB Clustered is a highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

InfluxDB Clustered is currently in limited availability and is only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.

Learn more
Contact InfluxData Sales

The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following:

InfluxDB Cloud powered by TSM