This is documentation for the next version of Grafana documentation. For the latest stable release, go to the latest version.

Documentation Grafana documentation Data sources InfluxDB Configure the InfluxDB data source

Configure the InfluxDB data source

This document provides instructions for configuring the InfluxDB data source and explains the available configuration options.

Before you begin

To configure the InfluxDB data source you must have the Administrator role.

InfluxData provides three query languages. Some key points to consider:

• Flux is a functional data scripting language for InfluxDB 2.x. Refer to Query InfluxDB with Flux for a basic guide on working with Flux.
• InfluxQL is SQL-like query language developed by InfluxData. It doesn’t support more advanced functions such as JOINs.
• SQL is only available for InfluxDB v3.x.

To help choose the best language for your needs, refer to a comparison of Flux vs InfluxQL and Why InfluxData created Flux.

Add the InfluxDB data source

Complete the following steps to set up a new InfluxDB data source:

1. Click Connections in the left-side menu.
2. Click Add new connection.
3. Type InfluxDB in the search bar.
4. Select the InfluxDB data source.
5. Click Add new data source in the upper right.

You are taken to the Settings tab where you will configure the data source.

Configuration Options

The following is a list of configuration options for InfluxDB.

The first option is to configure the name of your connection.

• Name - Sets the name you use to refer to the data source in panels and queries. Examples: InfluxDB-InfluxQL, InfluxDB_SQL.
• Default - Toggle to set as the default data source.

URL and Authentication

These settings identify the Influx instance and schema the data source is connecting to.

• URL - The HTTP protocol, IP address, and port of your InfluxDB API. InfluxDB’s default API port is 8086.
• Product - Select the product version of your Influx instance.
• Query language - Select the query language for your InfluxDB instance. This will determine the connection details needed in Database Settings. The three options are:
  • Flux - Flux is a data scripting language developed by InfluxData that allows you to query, analyze, and act on data. Refer to Get started with Flux for guidance on using Flux.
  • InfluxQL - SQL-like language for querying InfluxDB, with statements such as SELECT, FROM, WHERE, and GROUP BY that are familiar to SQL users.
  • SQL - Native SQL language starting with InfluxDB v.3.0. Refer to InfluxData’s SQL reference documentation for a list of supported statements, operators, and functions.

Advanced HTTP Settings (Optional)

Advanced HTTP Settings are optional settings that can be configured for more control over your data source.

• Allowed cookies - Defines which cookies are forwarded to the data source. All other cookies are deleted by default.
• Timeout - Set an HTTP request timeout in seconds.

Custom HTTP Headers

Click + Add header to add one or more HTTP headers. HTTP headers pass additional context and metadata about the request/response.

• Header - Add a custom HTTP header. Select an option from the drop-down. Allows custom headers to be passed based on the needs of your InfluxDB instance.
• Value - The value for the header.

Auth and TSL/SSL Settings (Optional)

There are several authentication methods you can choose in the Authentication section.

• No Authentication - Make the data source available without authentication. Grafana recommends using some type of authentication method.
• Basic auth - The most common authentication method. Use your Influx instance username and password to authenticate.
• Forward OAuth identity - Forward the OAuth access token (and also the OIDC ID token if available) of the user querying the data source.
• With credentials - Toggle to enable credentials such as cookies or auth headers to be sent with cross-site requests.

TLS/SSL Certificates are encrypted and stored in the Grafana database.

• TLS client auth - When enabled, add the Server name, Client cert and Client key. The client provides a certificate that the server validates to establish the client’s trusted identity. The client key encrypts the data between client and server.
  • Server name - Name of the server. Example: server1.domain.com
  • Client cert - Add the client certificate.
  • Client key - Add the client key.
• CA cert - Authenticate with a CA certificate. When enabled, follow the instructions of your CA (Certificate Authority) to download the certificate file.
• Skip TLS verify - Toggle to bypass TLS certificate validation.

Database Settings

These settings identify the Influx database your data source will connect to. The required information will vary by the query language selected in URL and Authentication. Each query language uses a different set of connection details.

The table below illustrates the details needed for each query language:

• Bucket or Database - Sets the ID of the bucket to query. Refer to View buckets in InfluxData’s documentation on how to locate the list of available buckets and their corresponding IDs.
• Organization - Sets the Influx organization used for Flux queries. Also used for the v.organization query macro.
• Password or Token - Specify the token used to query the bucket defined in Database. Retrieve this from the Tokens page in the InfluxDB UI.
• User - Add the username used to sign in to InfluxDB.

For Flux

• Default bucket is optional. The Influx bucket used for the v.defaultBucket macro in Flux queries.
• With Influx 2.0 products, use the influx authentication token to function. Token must be set as Authorization header with the value Token <generated-token>.
• For Influx 1.8, the token is username:password.

Advanced Database Settings (Optional)

Advanced Database Settings are optional settings that give you more control over the query experience.

• Min time interval - Sets the minimum time interval for auto group-by. Grafana recommends setting this to match the data write frequency. For example, if your data is written every minute, it’s recommended to set this interval to 1 minute, so that each group contains data from each new write. The default is 10s. Refer to Min time interval for format examples.
• Max series - Sets a limit on the maximum number of series or tables that Grafana processes. Set a lower limit to prevent system overload, or increase it if you have many small time series and need to display more of them. The default is 1000.

For InfluxQL

• HTTP method - Sets the HTTP method used to query your data source. The POST method allows for larger queries that would return an error using the GET method. The default method is POST.
• Autocomplete range - Sets a time range limit for the query editor’s autocomplete to reduce the execution time of tag filter queries. As a result, any tags not present within the defined time range will be filtered out. For example, setting the value to 12h will include only tag keys/values from the past 12 hours. This feature is recommended for use with very large databases, where significant performance improvements can be observed.

For SQL

• Insecure Connection - Toggle to disable gRPC TLS security.

Private Data Source Connect

For Grafana Cloud only. Private data source connect (PDC) allows you to establish a private, secured connection between a Grafana Cloud instance, or stack, and data sources secured within a private network. Click the drop-down to locate the URL for PDC. For more information regarding Grafana PDC refer to Private data source connect (PDC).

Click Manage private data source connect to be taken to your PDC connection page, where you’ll find your PDC configuration details.

After you have added your connection settings, click Save & test to test the data source connection.

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:

You can also override this setting in a dashboard panel under its data source options.

Provision the InfluxDB 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 Provision Grafana.

Provisioning examples

Provisioning differs based on query language.

InfluxDB 1.x example:

yaml Copy

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:

yaml Copy

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:

yaml Copy

apiVersion: 1

datasources:
  - name: InfluxDB_v2_InfluxQL
    type: influxdb
    access: proxy
    url: http://localhost:8086
    jsonData:
      dbName: site
      httpHeaderName1: 'Authorization'
    secureJsonData:
      httpHeaderValue1: 'Token <token>'

InfluxDB 3.x for SQL example:

yaml Copy

apiVersion: 1

datasources:
  - name: InfluxDB_v3_InfluxQL
    type: influxdb
    access: proxy
    url: http://localhost:8086
    jsonData:
      version: SQL
      dbName: site
      httpMode: POST
      insecureGrpc: false
    secureJsonData:
      token: '<api-token>'