added configuration options reference doc, resolves #142
Scott Anderson
parent
68abc5d1cb
commit
2a8872f02d
|
|
@ -15,6 +15,7 @@ preserveTaxonomyNames = true
|
|||
# Markdown rendering options
|
||||
[blackfriday]
|
||||
hrefTargetBlank = true
|
||||
smartDashes = false
|
||||
|
||||
# Menu items without actual pages
|
||||
[menu]
|
||||
|
|
|
|||
|
|
@ -7,7 +7,19 @@ menu:
|
|||
weight: 2
|
||||
---
|
||||
|
||||
Set InfluxDB configuration options when starting `influxd` by passing specific flags.
|
||||
Configure InfluxDB using configuration flags available with the [`influxd` daemon](/v2.0/reference/cli/influxd).
|
||||
The following configuration options are available:
|
||||
|
||||
- [assets-path](#assets-path)
|
||||
- [bolt-path](#bolt-path)
|
||||
- [e2e-testing](#e2e-testing)
|
||||
- [engine-path](#engine-path)
|
||||
- [http-bind-address](#http-bind-address)
|
||||
- [log-level](#log-level)
|
||||
- [reporting-disabled](#reporting-disabled)
|
||||
- [secret-store](#secret-store)
|
||||
- [store](#store)
|
||||
- [tracing-type](#tracing-type)
|
||||
|
||||
```sh
|
||||
influxd \
|
||||
|
|
@ -23,62 +35,128 @@ influxd \
|
|||
--tracing-type=log
|
||||
```
|
||||
|
||||
## assets-path
|
||||
Override default user interface (UI) assets by serving assets from a specific directory.
|
||||
_InfluxData use this when working on the InfluxDB UI._
|
||||
---
|
||||
|
||||
**influxd flag:** `--assets-path`
|
||||
## --assets-path
|
||||
Overrides the default InfluxDB user interface (UI) assets by serving assets from a specific directory.
|
||||
_This is typically only used internally at InfluxData when working on the InfluxDB UI._
|
||||
|
||||
## bolt-path
|
||||
Path to BoltDB database.
|
||||
```sh
|
||||
influxd --assets-path=/path/to/custom/assets-dir
|
||||
```
|
||||
|
||||
**influxd flag:** `--bolt-path`
|
||||
**Default:** `~/.influxdbv2/influxd.bolt`
|
||||
---
|
||||
|
||||
## e2e-testing
|
||||
Add /debug/flush endpoint to clear stores; used for end-to-end tests.
|
||||
## --bolt-path
|
||||
Defines the path to the [BoltDB](https://github.com/boltdb/bolt) database.
|
||||
BoltDB is a key value store written in Go.
|
||||
InfluxDB uses BoltDB to store non-time-series data such as organization and
|
||||
user information, UI data, REST resources, etc.
|
||||
|
||||
**influxd flag:** `--e2e-testing`
|
||||
**Default:** false
|
||||
**Default:** `~/.influxdbv2/influxd.bolt`
|
||||
|
||||
## engine-path
|
||||
Path to persistent storage engine files where InfluxDB stores all Time-Structure Merge Tree (TSM) data.
|
||||
```sh
|
||||
influxd --bolt-path=~/.influxdbv2/influxd.bolt
|
||||
```
|
||||
|
||||
**influxd flag:** `--engine-path`
|
||||
**Default:** `~/.influxdbv2/engine`
|
||||
---
|
||||
|
||||
## http-bind-address
|
||||
Bind address for the REST HTTP API.
|
||||
## --e2e-testing
|
||||
Adds a `/debug/flush` endpoint to the InfluxDB HTTP API to clear stores.
|
||||
InfluxData uses this for end-to-end testing.
|
||||
|
||||
**influxd flag:** `--http-bind-address`
|
||||
**Default:** `:9999`
|
||||
```sh
|
||||
influxd --e2e-testing
|
||||
```
|
||||
|
||||
## log-level
|
||||
Supported log levels are debug, info, and error.
|
||||
---
|
||||
|
||||
**influxd flag:** `--log-level`
|
||||
**Default:** `info`
|
||||
## --engine-path
|
||||
Defines the path to persistent storage engine files where InfluxDB stores all
|
||||
Time-Structure Merge Tree (TSM) data on disk.
|
||||
|
||||
## reporting-disabled
|
||||
Disable sending telemetry data to InfluxData.
|
||||
**Default:** `~/.influxdbv2/engine`
|
||||
|
||||
**influxd flag:** `--reporting-disabled`
|
||||
**Default:** false
|
||||
```sh
|
||||
influxd --engine-path=~/.influxdbv2/engine
|
||||
```
|
||||
|
||||
## secret-store
|
||||
Data store for secrets (bolt or vault).
|
||||
---
|
||||
|
||||
**influxd flag:** `--secret-store`
|
||||
**Default:** `bolt`
|
||||
## --http-bind-address
|
||||
Defines the bind address for the InfluxDB HTTP API.
|
||||
Customize the URL and port of the InfluxDB API and UI.
|
||||
|
||||
## store
|
||||
Data store for REST resources (bolt or memory) (default `bolt`)
|
||||
**Default:** `:9999`
|
||||
|
||||
**influxd flag:** `--store`
|
||||
**Default:** `bolt`
|
||||
```sh
|
||||
influxd --http-bind-address=:9999
|
||||
```
|
||||
|
||||
## tracing-type
|
||||
Supported tracing types (log or jaeger).
|
||||
---
|
||||
|
||||
**influxd flag:** `--tracing-type`
|
||||
**Default:** none
|
||||
## --log-level
|
||||
Defines the log output level.
|
||||
InfluxDB emits log entries with severity levels greater than or equal to the level specified.
|
||||
|
||||
**Options:** `debug`, `info`, `error`
|
||||
**Default:** `info`
|
||||
|
||||
```sh
|
||||
influxd --log-level=info
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## --reporting-disabled
|
||||
Disables sending telemetry data to InfluxData.
|
||||
The [InfluxData telemetry](https://www.influxdata.com/telemetry) page provides
|
||||
information about what data is collected and how InfluxData uses it.
|
||||
|
||||
```sh
|
||||
influxd --reporting-disabled
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## --secret-store
|
||||
Specifies the data store for secrets such as passwords and tokens.
|
||||
Store secrets in either the InfluxDB [internal BoltDB](#bolt-path)
|
||||
or in [Vault](https://www.vaultproject.io/).
|
||||
|
||||
**Options:** `bolt`, `vault`
|
||||
**Default:** `bolt`
|
||||
|
||||
```sh
|
||||
influxd --secret-store=bolt
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## --store
|
||||
Specifies the data store for REST resources.
|
||||
|
||||
{{% note %}}
|
||||
Do not use `memory` in production environments.
|
||||
It is meant only for transient environments, such as testing environments, where
|
||||
data persistence does not matter.
|
||||
{{% /note %}}
|
||||
|
||||
**Options:** `bolt`, `memory`
|
||||
**Default:** `bolt`
|
||||
|
||||
```sh
|
||||
influxd --store=bolt
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## --tracing-type
|
||||
Enables tracing in InfluxDB and specifies the tracing type.
|
||||
Tracing is disabled by default.
|
||||
|
||||
**Options:** `log`, `jaeger`
|
||||
|
||||
```sh
|
||||
influxd --tracing-type=log
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in New Issue