4.2 KiB
| title | description | menu | ||||||
|---|---|---|---|---|---|---|---|---|
| InfluxDB configuration options | Configure InfluxDB when starting the `influxd` service. This article outlines the different configuration options available. |
|
To configure InfluxDB, use the following configuration options when starting the
influxd service:
- --assets-path
- --bolt-path
- --e2e-testing
- --engine-path
- --http-bind-address
- --log-level
- --reporting-disabled
- --secret-store
- --session-length
- --session-renew-disabled
- --store
- --tracing-type
influxd \
--assets-path=/path/to/custom/assets-dir \
--bolt-path=~/.influxdbv2/influxd.bolt \
--e2e-testing \
--engine-path=~/.influxdbv2/engine \
--http-bind-address=:9999 \
--log-level=info \
--reporting-disabled \
--secret-store=bolt \
--session-length=60 \
--session-renew-disabled \
--store=bolt \
--tracing-type=log
--assets-path
Typically, InfluxData internal use only. Overrides the default InfluxDB user interface (UI) assets by serving assets from the specified directory.
influxd --assets-path=/path/to/custom/assets-dir
--bolt-path
Defines the path to the BoltDB database. BoltDB is a key value store written in Go. InfluxDB uses BoltDB to store data including organization and user information, UI data, REST resources, and other key value data.
Default: ~/.influxdbv2/influxd.bolt
influxd --bolt-path=~/.influxdbv2/influxd.bolt
--e2e-testing
Adds a /debug/flush endpoint to the InfluxDB HTTP API to clear stores.
InfluxData uses this endpoint in end-to-end testing.
influxd --e2e-testing
--engine-path
Defines the path to persistent storage engine files where InfluxDB stores all Time-Structure Merge Tree (TSM) data on disk.
Default: ~/.influxdbv2/engine
influxd --engine-path=~/.influxdbv2/engine
--http-bind-address
Defines the bind address for the InfluxDB HTTP API. Customize the URL and port for the InfluxDB API and UI.
Default: :9999
influxd --http-bind-address=:9999
--log-level
Defines the log output level. InfluxDB outputs log entries with severity levels greater than or equal to the level specified.
Options: debug, info, error
Default: info
influxd --log-level=info
--reporting-disabled
Disables sending telemetry data to InfluxData. The InfluxData telemetry page provides information about what data is collected and how InfluxData uses it.
influxd --reporting-disabled
--secret-store
Specifies the data store for secrets such as passwords and tokens. Store secrets in either the InfluxDB internal BoltDB or in Vault.
Options: bolt, vault
Default: bolt
influxd --secret-store=bolt
--session-length
Specifies the Time to Live (TTL) in minutes for newly created user sessions.
Default: 60
influxd --session-length=60
--session-renew-disabled
Disables automatically extending a user's session TTL on each request. By default, every request sets the session's expiration time to five minutes from now. When disabled, sessions expire after the specified session length and the user is redirected to the login page, even if recently active.
influxd --session-renew-disabled
--store
Specifies the data store for REST resources.
Options: bolt, memory
Default: bolt
{{% note %}}
memory is meant for transient environments, such as testing environments, where
data persistence does not matter.
InfluxData does not recommend using memory in production.
{{% /note %}}
influxd --store=bolt
--tracing-type
Enables tracing in InfluxDB and specifies the tracing type. Tracing is disabled by default.
Options: log, jaeger
influxd --tracing-type=log