Using Configuration Files

Print a default configuration file

The following commands print out a TOML-formatted configuration with all available options set to their default values.

Meta configuration:

influxd-meta config

Data configuration:

influxd config

Create a configuration file

On POSIX systems, generate a new configuration file by redirecting the output of the command to a file.

New meta configuration file:

influxd-meta config > /etc/influxdb/influxdb-meta-generated.conf

New data configuration file:

influxd config > /etc/influxdb/influxdb-generated.conf

Preserve custom settings from older configuration files when generating a new configuration file with the -config option. For example, this overwrites any default configuration settings in the output file (/etc/influxdb/influxdb.conf.new) with the configuration settings from the file (/etc/influxdb/influxdb.conf.old) passed to -config:

influxd config -config /etc/influxdb/influxdb.conf.old > /etc/influxdb/influxdb.conf.new

Launch the process with a configuration file

There are two ways to launch the meta or data processes using your customized configuration file.

Point the process to the desired configuration file with the -config option.
To start the meta node process with /etc/influxdb/influxdb-meta-generate.conf:
```
influxd-meta -config /etc/influxdb/influxdb-meta-generate.conf
```
To start the data node process with /etc/influxdb/influxdb-generated.conf:
```
influxd -config /etc/influxdb/influxdb-generated.conf
```
Set the environment variable INFLUXDB_CONFIG_PATH to the path of your configuration file and start the process.
To set the INFLUXDB_CONFIG_PATH environment variable and launch the data process using INFLUXDB_CONFIG_PATH for the configuration file path:
```
export INFLUXDB_CONFIG_PATH=/root/influxdb.generated.conf
echo $INFLUXDB_CONFIG_PATH
/root/influxdb.generated.conf
influxd
```

If set, the command line -config path overrides any environment variable path. If you do not supply a configuration file, InfluxDB uses an internal default configuration (equivalent to the output of influxd config and influxd-meta config).

Environment variables

All configuration options can be specified in the configuration file or in an environment variable. The environment variable overrides the equivalent option in the configuration file. If a configuration option is not specified in either the configuration file or in an environment variable, InfluxDB uses its internal default configuration.

In the sections below we name the relevant environment variable in the description for the configuration setting. Environment variables can be set in /etc/default/influxdb-meta and /etc/default/influxdb.

Note: To set or override settings in a config section that allows multiple configurations (any section with [[double_brackets]] in the header supports multiple configurations), the desired configuration must be specified by ordinal number. For example, for the first set of [[graphite]] environment variables, prefix the configuration setting name in the environment variable with the relevant position number (in this case: 0):
INFLUXDB_GRAPHITE_0_BATCH_PENDING
INFLUXDB_GRAPHITE_0_BATCH_SIZE
INFLUXDB_GRAPHITE_0_BATCH_TIMEOUT
INFLUXDB_GRAPHITE_0_BIND_ADDRESS
INFLUXDB_GRAPHITE_0_CONSISTENCY_LEVEL
INFLUXDB_GRAPHITE_0_DATABASE
INFLUXDB_GRAPHITE_0_ENABLED
INFLUXDB_GRAPHITE_0_PROTOCOL
INFLUXDB_GRAPHITE_0_RETENTION_POLICY
INFLUXDB_GRAPHITE_0_SEPARATOR
INFLUXDB_GRAPHITE_0_TAGS
INFLUXDB_GRAPHITE_0_TEMPLATES
INFLUXDB_GRAPHITE_0_UDP_READ_BUFFER
For the Nth Graphite configuration in the configuration file, the relevant environment variables would be of the form INFLUXDB_GRAPHITE_(N-1)_BATCH_PENDING. For each section of the configuration file the numbering restarts at zero.

Meta Node Configuration

Global options

reporting-disabled = false

InfluxData, the company, relies on reported data from running nodes primarily to track the adoption rates of different InfluxDB versions. These data help InfluxData support the continuing development of InfluxDB.

The reporting-disabled option toggles the reporting of data every 24 hours to usage.influxdata.com. Each report includes a randomly-generated identifier, OS, architecture, InfluxDB version, and the number of databases, measurements, and unique series. Setting this option to true will disable reporting.

Note: No data from user databases are ever transmitted.

bind-address = “”

This setting is not intended for use. It will be removed in future versions.

hostname = “”

The hostname of the meta node. This must be resolvable and reachable by all other members of the cluster.

[enterprise]

The [enterprise] section contains the parameters for the meta node’s registration with the InfluxDB Enterprise Web Console and the InfluxEnterprise License Portal.

registration-enabled = true

Set to true to enable registration with the InfluxDB Enterprise web console. All meta nodes must have registration-enabled set to true for the InfluxDB Enterprise Web Console to function properly.

Environment variable: INFLUXDB_ENTERPRISE_REGISTRATION_ENABLED

registration-server-url = “http://IP_or_hostname:3000"

The full URL of the server that runs the InfluxDB Enterprise web console. All meta nodes must have registration-server-url set to the full protocol, hostname, and port for the InfluxDB Enterprise Web Console to function properly.

Environment variable: INFLUXDB_ENTERPRISE_REGISTRATION_SERVER_URL

license-key = “”

The license key that you created on InfluxPortal. The meta node transmits the license key to portal.influxdata.com over port 80 or port 443 and receives a temporary JSON license file in return. The server caches the license file locally. You must use the license-path setting if your server cannot communicate with https://portal.influxdata.com.

Environment variable: INFLUXDB_ENTERPRISE_LICENSE_KEY

license-path = “”

The local path to the permanent JSON license file that you received from InfluxData. Permanent license files are not available for subscribers on a monthly plan. If you are a monthly subscriber, your cluster must use the license-key setting. Contact sales@influxdb.com to become an annual subscriber.

Environment variable: INFLUXDB_ENTERPRISE_LICENSE_PATH

[meta]

dir = “/var/lib/influxdb/meta”

The location of the meta directory which stores the metastore.

Environment variable: INFLUXDB_META_DIR

bind-address = “:8089”

The bind address/port for meta node communication. For simplicity we recommend using the same port on all meta nodes, but this is not necessary.

Environment variable: INFLUXDB_META_BIND_ADDRESS

http-bind-address = “:8091”

The port used by the influxd-ctl tool and by data nodes to access the meta APIs. For simplicity we recommend using the same port on all meta nodes, but this is not necessary.

Environment variable: INFLUXDB_META_HTTP_BIND_ADDRESS

https-enabled = false

Set to true to if using HTTPS over the 8091 API port. Currently, the 8089 and 8088 ports do not support TLS.

Environment variable: INFLUXDB_META_HTTPS_ENABLED

https-certificate = “”

The path of the certificate file. This is required if https-enabled is set to true.

Environment variable: INFLUXDB_META_HTTPS_CERTIFICATE

gossip-frequency = “5s”

The frequency at which meta nodes communicate the cluster membership state.

Environment variable: INFLUXDB_META_GOSSIP_FREQUENCY

announcement-expiration = “30s”

The rate at which the results of influxd-ctl show are updated when a meta node leaves the cluster. Note that in version 1.0, configuring this setting provides no change from the user’s perspective.

Environment variable: INFLUXDB_META_ANNOUNCEMENT_EXPIRATION

retention-autocreate = true

Set to false to disable the automatic creation of an autogen retention policy for new databases.

If set to true, InfluxDB automatically creates a DEFAULT retention policy when a database is created. That retention policy is called autogen, has an infinite duration, a one week shard duration, and a replication factor set to the number of nodes in the cluster. If set to false, you must explicitly create a DEFAULT retention policy on every new database before that database can accept any writes.

Environment variable: INFLUXDB_META_RETENTION_AUTOCREATE

election-timeout = “1s”

The duration a Raft candidate spends in the candidate state without a leader before it starts an election. The election timeout is slightly randomized on each Raft node each time it is called. An additional jitter is added to the election-timeout duration of between zero and the election-timeout. The default setting should work for most systems.

Environment variable: INFLUXDB_META_ELECTION_TIMEOUT

heartbeat-timeout = “1s”

The heartbeat timeout is the amount of time a Raft follower remains in the follower state without a leader before it starts an election. Clusters with high latency between nodes may want to increase this parameter to avoid unnecessary Raft elections.

Environment variable: INFLUXDB_META_HEARTBEAT_TIMEOUT

leader-lease-timeout = “500ms”

The leader lease timeout is the amount of time a Raft leader will remain leader if it does not hear from a majority of nodes. After the timeout the leader steps down to the follower state. Clusters with high latency between nodes may want to increase this parameter to avoid unnecessary Raft elections.

Environment variable: INFLUXDB_META_LEADER_LEASE_TIMEOUT

commit-timeout = “50ms”

The commit timeout is the amount of time a Raft node will tolerate between commands before issuing a heartbeat to tell the leader it is alive. The default setting should work for most systems.

Environment variable: INFLUXDB_META_COMMIT_TIMEOUT

cluster-tracing = false

Cluster tracing toggles the logging of Raft logs on Raft nodes. Enable this setting when debugging Raft consensus issues.

Environment variable: INFLUXDB_META_CLUSTER_TRACING

logging-enabled = true

Meta logging toggles the logging of messages from the meta service.

Environment variable: INFLUXDB_META_LOGGING_ENABLED

pprof-enabled = false

Set to true to enable the /debug/pprof endpoint for troubleshooting.

Environment variable: INFLUXDB_META_PPROF_ENABLED

lease-duration = “1m0s”

The default duration of the leases that data nodes acquire from the meta nodes. Leases automatically expire after the lease-duration is met.

Leases ensure that only one data node is running something at a given time. For example, Continuous Queries (CQ) use a lease so that all data nodes aren’t running the same CQs at once.

Environment variable: INFLUXDB_META_LEASE_DURATION

Data Node Configuration

The InfluxDB Enterprise data node configuration settings overlap significantly with the settings in InfluxDB’s Open Source Software (OSS). Where possible, the following sections link to the configuration documentation for InfluxDB’s OSS.

Note: The system has internal defaults for every configuration file setting. View the default settings with the influxd config command. The local configuration file (/etc/influxdb/influxdb.conf) overrides any internal defaults but the configuration file does not need to include every configuration setting. Starting with version 1.0.1, most of the settings in the local configuration file are commented out. All commented-out settings will be determined by the internal defaults.

Configuration

Using Configuration Files

Print a default configuration file

Create a configuration file

Launch the process with a configuration file

Environment variables

Meta Node Configuration

Global options

reporting-disabled = false

bind-address = “”

hostname = “”

[enterprise]

registration-enabled = true

registration-server-url = “http://IP_or_hostname:3000"

license-key = “”

license-path = “”

[meta]

dir = “/var/lib/influxdb/meta”

bind-address = “:8089”

http-bind-address = “:8091”

https-enabled = false

https-certificate = “”

gossip-frequency = “5s”

announcement-expiration = “30s”

retention-autocreate = true

election-timeout = “1s”

heartbeat-timeout = “1s”

leader-lease-timeout = “500ms”

commit-timeout = “50ms”

cluster-tracing = false

logging-enabled = true

pprof-enabled = false

lease-duration = “1m0s”

Data Node Configuration

Global options

reporting-disabled = false

bind-address = “:8088”

hostname = “localhost”

[enterprise]

registration-enabled = false

registration-server-url = “http://IP_or_hostname:3000"

license-key = “”

license-path = “”

[meta]

dir = “/var/lib/influxdb/meta”

meta-tls-enabled = false

meta-insecure-tls = false

retention-autocreate = true

logging-enabled = true

[data]

dir = “/var/lib/influxdb/data”

wal-dir = “/var/lib/influxdb/wal”

wal-logging-enabled = true

query-log-enabled = true

cache-max-memory-size = 524288000

cache-snapshot-memory-size = 26214400

cache-snapshot-write-cold-duration = “1h0m0s”

compact-full-write-cold-duration = “24h0m0s”

max-series-per-database = 1000000

trace-logging-enabled = false

[cluster]

dial-timeout = “1s”

shard-writer-timeout = “5s”

shard-reader-timeout = “0”

max-remote-write-connections = 50

cluster-tracing = false

write-timeout = “10s”

max-concurrent-queries = 0

query-timeout = “0”

log-queries-after = “0”

max-select-point = 0

max-select-series = 0

max-select-buckets = 0

[retention]

enabled = true

check-interval = “30m0s”

[shard-precreation]

enabled = true

check-interval = “10m0s”

advance-period = “30m0s”