InfluxDB data source
InfluxDB is an open-source time series database (TSDB) developed by InfluxData. It is optimized for fast, high-availability storage and retrieval of time series data in fields such as operations monitoring, application metrics, IoT sensor data, and real-time analytics.
Grafana includes built-in support for InfluxDB. This topic explains options, variables, querying, and other features specific to the InfluxDB data source, which include its feature-rich code editor for queries and visual query builder.
For instructions on how to add a data source to Grafana, refer to the administration documentation. Only users with the organization administrator role can add data sources. Administrators can also configure the data source via YAML with Grafana’s provisioning system.
Configure the data source
To configure basic settings for the data source, complete the following steps:
Click Connections in the left-side menu.
Under Your connections, click Data sources.
InfluxDBin the search bar.
The Settings tab of the data source is displayed.
Set the data source’s basic configuration options carefully:
|Name||Sets the name you use to refer to the data source in panels and queries. We recommend something like |
|Default||Sets whether the data source is pre-selected for new panels.|
|URL||The HTTP protocol, IP address, and port of your InfluxDB API. InfluxDB’s default API port is 8086.|
|Min time interval||(Optional) Refer to Min time interval.|
|Max series||(Optional) Limits the number of series and tables that Grafana processes. Lower this number to prevent abuse, and increase it if you have many small time series and not all are shown. Defaults to 1,000.|
You can also configure settings specific to the InfluxDB data source. These options are described in the sections below.
Min time interval
The Min time interval setting defines a lower limit for the auto group-by time interval.
This value must be formatted as a number followed by a valid time identifier:
We recommend setting this value to match your InfluxDB write frequency.
For example, use
1m if InfluxDB writes data every minute.
You can also override this setting in a dashboard panel under its data source options.
Select a query language
InfluxDB data source options differ depending on which query language you select:
- InfluxQL, a SQL-like language for querying InfluxDB, with statements such as SELECT, FROM, WHERE, and GROUP BY that are familiar to SQL users. InfluxQL is available in InfluxDB 1.0 onwards.
Though not required, we recommend that you append your query language choice to the data source’s Name setting:
Configure these options if you select the InfluxQL (classic InfluxDB) query language:
|Allowed cookies||Defines which cookies are forwarded to the data source. All other cookies are deleted.|
|Database||Sets the ID of the bucket to query. Copy this from the Buckets page of the InfluxDB UI.|
|User||Sets the username to sign into InfluxDB.|
|Password||Defines the token you use to query the bucket defined in Database. Copy this from the Tokens page of the InfluxDB UI.|
|HTTP mode||Sets the HTTP method used to query your data source. The POST verb allows for larger queries that would return an error using the GET verb. Defaults to GET.|
Configure these options if you select the Flux query language:
|Organization||The Influx organization that will be used for Flux queries. This is also used to for the |
|Token||The authentication token used for Flux queries. With Influx 2.0, use the influx authentication token to function. Token must be set as |
|Default bucket||(Optional) The Influx bucket that will be used for the |
Provision the data source
You can define and configure the data source in YAML files as part of Grafana’s provisioning system. For more information about provisioning, and for available configuration options, refer to Provisioning Grafana.
databasefield is deprecated. We suggest to use
jsonData. Please see the examples below. No need to change existing provisioning settings.
InfluxDB 1.x example:
apiVersion: 1 datasources: - name: InfluxDB_v1 type: influxdb access: proxy user: grafana url: http://localhost:8086 jsonData: dbName: site httpMode: GET secureJsonData: password: grafana
InfluxDB 2.x for Flux example:
apiVersion: 1 datasources: - name: InfluxDB_v2_Flux type: influxdb access: proxy url: http://localhost:8086 jsonData: version: Flux organization: organization defaultBucket: bucket tlsSkipVerify: true secureJsonData: token: token
InfluxDB 2.x for InfluxQL example:
apiVersion: 1 datasources: - name: InfluxDB_v2_InfluxQL type: influxdb access: proxy url: http://localhost:8086 jsonData: # This database should be mapped to a bucket dbName: site httpMode: GET httpHeaderName1: 'Authorization' secureJsonData: httpHeaderValue1: 'Token <token>'
Query the data source
The InfluxDB data source’s query editor has two modes, InfluxQL and Flux, depending on your choice of query language in the data source configuration:
For details, refer to the query editor documentation.
Use template variables
Instead of hard-coding details such as server, application, and sensor names in metric queries, you can use variables. Grafana lists these variables in dropdown select boxes at the top of the dashboard to help you change the data displayed in your dashboard. Grafana refers to such variables as template variables.
For details, see the template variables documentation.