InfluxDB Enterprise mode configurations
This page documents an earlier version of InfluxDB Enterprise. InfluxDB Enterprise v1.9 is the latest stable version.
Meta node configurations
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.
reporting-disabledoption 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
truewill 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]section contains the parameters for the meta node’s registration with the InfluxDB Enterprise License Portal.
license-key = ""
The license key created for you 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-pathsetting if your server cannot communicate with https://portal.influxdata.com.
Use the same key for all nodes in the same cluster.
license-pathsettings are mutually exclusive and one must remain set to the empty string.
We recommended performing rolling restarts on the nodes after the license key update. Restart one Meta, Data, or Enterprise service at a time and wait for it to come back up successfully. The cluster should remain unaffected as long as only one node is restarting at a time as long as there are two or more data nodes.
license-path = ""
The local path to the permanent JSON license file that you received from InfluxData for instances that do not have access to the internet. Contact firstname.lastname@example.org if a licence file is required.
The license file should be saved on every server in the cluster, including Meta, Data, and Enterprise nodes. The file contains the JSON-formatted license, and must be readable by the influxdb user. Each server in the cluster independently verifies its license.
The `license-key` and `license-path` settings are mutually exclusive and one must remain set to the empty string.
We recommended performing rolling restarts on the nodes after the license file update. Restart one Meta, Data, or Enterprise service at a time and wait for it to come back up successfully. The cluster should remain unaffected as long as only one node is restarting at a time as long as there are two or more data nodes.
dir = "/var/lib/influxdb/meta"
The location of the meta directory which stores the metastore.
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.
auth-enabled = false
trueto enable authentication. Meta nodes support JWT authentication and Basic authentication. For JWT authentication, also see the
If set to
true, also set the
[meta]section of the data node configuration file.
http-bind-address = ":8091"
The port used by the
influxd-ctltool 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.
https-enabled = false
trueto if using HTTPS over the
8091API port. Currently, the
8088ports do not support TLS.
https-certificate = ""
The path of the certificate file. This is required if
https-enabledis set to
https-private-key = ""
The path of the private key file.
https-insecure-tls = false
trueto allow insecure HTTPS connections to meta nodes. Use this setting when testing with self-signed certificates.
gossip-frequency = "5s"
The frequency at which meta nodes communicate the cluster membership state.
announcement-expiration = "30s"
The rate at which the results of
influxd-ctl showare 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.
retention-autocreate = true
Automatically creates a default retention policy (RP) when the system creates a database. The default RP (
autogen) has an infinite duration, a shard group duration of seven days, and a replication factor set to the number of data nodes in the cluster. The system targets the
autogenRP when a write or query does not specify an RP. Set this option to
falseto prevent the system from creating the
autogenRP when the system creates a database.
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-timeoutduration of between zero and the
election-timeout. The default setting should work for most systems.
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.
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.
consensus-timeout = "30s"
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.
cluster-tracing = false
Cluster tracing toggles the logging of Raft logs on Raft nodes. Enable this setting when debugging Raft consensus issues.
logging-enabled = true
Meta logging toggles the logging of messages from the meta service.
pprof-enabled = true
falseto disable the
/debug/pprofendpoint for troubleshooting.
lease-duration = "1m0s"
The default duration of the leases that data nodes acquire from the meta nodes. Leases automatically expire after the
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.
shared-secret = ""
The shared secret to be used by the public API for creating custom JWT authentication. Set
trueif using this option.
internal-shared-secret = ""
The shared secret used by the internal API for JWT authentication. Set this to a long pass phrase. This value must be the same as the value of the
[meta] meta-internal-shared-secretin the data node configuration file. Set
trueif using this option.
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, the following resources are available:
InfluxDB Cloud and InfluxDB Enterprise customers can contact InfluxData Support.