Merge pull request #931 from influxdata/influxd/config-options
Added missing InfluxDB configuration optionspull/942/head
Scott Anderson
GitHub
commit
913e6f88a5
|
|
@ -7,6 +7,8 @@ menu:
|
|||
name: influxd
|
||||
parent: Command line tools
|
||||
weight: 102
|
||||
related:
|
||||
- /v2.0/reference/config-options/
|
||||
---
|
||||
|
||||
The `influxd` daemon starts and runs all the processes necessary for InfluxDB to function.
|
||||
|
|
@ -30,33 +32,4 @@ influxd [command]
|
|||
|
||||
## Flags
|
||||
|
||||
| Flag | Description | Input type |
|
||||
|:---- |:----------- | :--------: |
|
||||
| `--assets-path` | Override default assets by serving from a specific directory (developer mode) | string |
|
||||
| `--bolt-path` | Path to boltdb database (default `~/.influxdbv2/influxd.bolt`) | string |
|
||||
| `--e2e-testing` | Add /debug/flush endpoint to clear stores; used for end-to-end tests (default `false`) | |
|
||||
| `--engine-path` | Path to persistent engine files (default `~/.influxdbv2/engine`) | string |
|
||||
| `-h`, `--help` | Help for the `influxd` command | |
|
||||
| `--http-bind-address` | Bind address for the REST HTTP API (default `:9999`) | string |
|
||||
| `--log-level` | Supported log levels are debug, info, and error (default `info`) | string |
|
||||
| `--new-meta-store` | Enables the new meta store | |
|
||||
| `--new-meta-store-read-only` | Toggle read-only mode for the new meta store and duplicate reads between old and new store (default `true`) | |
|
||||
| `--no-tasks` | Disables the task scheduler | |
|
||||
| `--reporting-disabled` | Disable sending telemetry data to **https:<nolink>//telemetry.influxdata.com** | |
|
||||
| `--secret-store` | Data store for secrets (bolt or vault) (default `bolt`) | string |
|
||||
| `--session-length` | TTL in minutes for newly created sessions (default `60`) | integer |
|
||||
| `--session-renew-disabled` | Disables automatically extending session TTL on request | |
|
||||
| `--store` | Data store for REST resources (bolt or memory) (default `bolt`) | string |
|
||||
| `--tls-cert` | Path to TLS certificate file | string |
|
||||
| `--tls-key` | Path to TLS private key file | string |
|
||||
| `--tracing-type` | Supported tracing types (log or jaeger) | string |
|
||||
| `--vault-addr ` | Address of the Vault server (example: `https://127.0.0.1:8200/`) | string |
|
||||
| `--vault-cacert` | Path to a PEM-encoded CA certificate file | string |
|
||||
| `--vault-capath` | Path to a directory of PEM-encoded CA certificate files | string |
|
||||
| `--vault-client-cert` | Path to a PEM-encoded client certificate | string |
|
||||
| `--vault-client-key` | Path to an unencrypted, PEM-encoded private key which corresponds to the matching client certificate | string |
|
||||
| `--vault-max-retries` | Maximum number of retries when encountering a 5xx error code (default `2`) | integer |
|
||||
| `--vault-client-timeout` | Vault client timeout (default `60s`) | duration |
|
||||
| `--vault-skip-verify` | Skip certificate verification when communicating with Vault | |
|
||||
| `--vault-tls-server-name` | Name to use as the SNI host when connecting to Vault via TLS | string |
|
||||
| `--vault-token` | Vault authentication token | string |
|
||||
{{% cli/influxd-flags %}}
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ menu:
|
|||
v2_0_ref:
|
||||
parent: influxd
|
||||
weight: 201
|
||||
related:
|
||||
- /v2.0/reference/config-options/
|
||||
---
|
||||
|
||||
The `influxd run` command is the default command for `influxd`.
|
||||
|
|
@ -28,30 +30,4 @@ influxd run
|
|||
|
||||
## Flags
|
||||
|
||||
| Flag | Description | Input type |
|
||||
| :--------------------- | :---------------------------------------------------------------------------------------------------- | :--------: |
|
||||
| `--assets-path` | Override default assets by serving from a specific directory (developer mode) | string |
|
||||
| `--bolt-path` | Path to boltdb database (default `~/.influxdbv2/influxd.bolt`) | string |
|
||||
| `--e2e-testing` | Add /debug/flush endpoint to clear stores; used for end-to-end tests (default `false`) | |
|
||||
| `--engine-path` | Path to persistent engine files (default `~/.influxdbv2/engine`) | string |
|
||||
| `-h`, `--help` | Help for the `influxd` command | |
|
||||
| `--http-bind-address` | Bind address for the REST HTTP API (default `:9999`) | string |
|
||||
| `--log-level` | Supported log levels are debug, info, and error (default `info`) | string |
|
||||
| `--reporting-disabled` | Disable sending telemetry data to **https:<nolink>//telemetry.influxdata.com** | |
|
||||
| `--secret-store` | Data store for secrets (bolt or vault) (default `bolt`) | string |
|
||||
| `--session-length` | TTL in minutes for newly created sessions (default `60`) | integer |
|
||||
| `--session-renew-disabled` | Disables automatically extending session TTL on request | |
|
||||
| `--store` | Data store for REST resources (bolt or memory) (default `bolt`) | string |
|
||||
| `--tls-cert` | Path to TLS certificate file | string |
|
||||
| `--tls-key` | Path to TLS private key file | string |
|
||||
| `--tracing-type` | Supported tracing types (log or jaeger) | string |
|
||||
| `--vault-addr ` | Address of the Vault server (example: `https://127.0.0.1:8200/`) | string |
|
||||
| `--vault-cacert` | Path to a PEM-encoded CA certificate file | string |
|
||||
| `--vault-capath` | Path to a directory of PEM-encoded CA certificate files | string |
|
||||
| `--vault-client-cert` | Path to a PEM-encoded client certificate | string |
|
||||
| `--vault-client-key` | Path to an unencrypted, PEM-encoded private key which corresponds to the matching client certificate | string |
|
||||
| `--vault-max-retries` | Maximum number of retries when encountering a 5xx error code (default `2`) | integer |
|
||||
| `--vault-client-timeout` | Vault client timeout (default `60s`) | duration |
|
||||
| `--vault-skip-verify` | Skip certificate verification when communicating with Vault | |
|
||||
| `--vault-tls-server-name` | Name to use as the SNI host when connecting to Vault via TLS | string |
|
||||
| `--vault-token` | Vault authentication token | string |
|
||||
{{% cli/influxd-flags %}}
|
||||
|
|
|
|||
|
|
@ -18,6 +18,14 @@ To configure InfluxDB, use the following configuration options when starting the
|
|||
- [--engine-path](#engine-path)
|
||||
- [--http-bind-address](#http-bind-address)
|
||||
- [--log-level](#log-level)
|
||||
- [--new-meta-store](#new-meta-store)
|
||||
- [--new-meta-store-read-only](#new-meta-store-read-only)
|
||||
- [--no-tasks](#no-tasks)
|
||||
- [--query-concurrency](#query-concurrency)
|
||||
- [--query-initial-memory-bytes](#query-initial-memory-bytes)
|
||||
- [--query-max-memory-bytes](#query-max-memory-bytes)
|
||||
- [--query-memory-bytes](#query-memory-bytes)
|
||||
- [--query-queue-size](#query-queue-size)
|
||||
- [--reporting-disabled](#reporting-disabled)
|
||||
- [--secret-store](#secret-store)
|
||||
- [--session-length](#session-length)
|
||||
|
|
@ -40,8 +48,8 @@ To configure InfluxDB, use the following configuration options when starting the
|
|||
---
|
||||
|
||||
## --assets-path
|
||||
Override the default InfluxDB user interface (UI) assets by serving assets from the specified directory.
|
||||
_Typically, InfluxData internal use only._
|
||||
Overrides the default InfluxDB user interface (UI) assets by serving assets from the specified directory.
|
||||
|
||||
```sh
|
||||
influxd --assets-path=/path/to/custom/assets-dir
|
||||
|
|
@ -50,7 +58,7 @@ influxd --assets-path=/path/to/custom/assets-dir
|
|||
---
|
||||
|
||||
## --bolt-path
|
||||
Defines the path to the [BoltDB](https://github.com/boltdb/bolt) database.
|
||||
Define 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 data including organization and
|
||||
user information, UI data, REST resources, and other key value data.
|
||||
|
|
@ -64,7 +72,7 @@ influxd --bolt-path=~/.influxdbv2/influxd.bolt
|
|||
---
|
||||
|
||||
## --e2e-testing
|
||||
Adds a `/debug/flush` endpoint to the InfluxDB HTTP API to clear stores.
|
||||
Add a `/debug/flush` endpoint to the InfluxDB HTTP API to clear stores.
|
||||
InfluxData uses this endpoint in end-to-end testing.
|
||||
|
||||
```sh
|
||||
|
|
@ -74,7 +82,7 @@ influxd --e2e-testing
|
|||
---
|
||||
|
||||
## --engine-path
|
||||
Defines the path to persistent storage engine files where InfluxDB stores all
|
||||
Define the path to persistent storage engine files where InfluxDB stores all
|
||||
Time-Structure Merge Tree (TSM) data on disk.
|
||||
|
||||
**Default:** `~/.influxdbv2/engine`
|
||||
|
|
@ -86,7 +94,7 @@ influxd --engine-path=~/.influxdbv2/engine
|
|||
---
|
||||
|
||||
## --http-bind-address
|
||||
Defines the bind address for the InfluxDB HTTP API.
|
||||
Define the bind address for the InfluxDB HTTP API.
|
||||
Customize the URL and port for the InfluxDB API and UI.
|
||||
|
||||
**Default:** `:9999`
|
||||
|
|
@ -98,7 +106,7 @@ influxd --http-bind-address=:9999
|
|||
---
|
||||
|
||||
## --log-level
|
||||
Defines the log output level.
|
||||
Define the log output level.
|
||||
InfluxDB outputs log entries with severity levels greater than or equal to the level specified.
|
||||
|
||||
**Options:** `debug`, `info`, `error`
|
||||
|
|
@ -110,6 +118,101 @@ influxd --log-level=info
|
|||
|
||||
---
|
||||
|
||||
## --new-meta-store
|
||||
Enable the new meta store.
|
||||
|
||||
**Default:** `false`
|
||||
|
||||
```sh
|
||||
influxd --new-meta-store=false
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## --new-meta-store-read-only
|
||||
Toggle read-only mode for the new meta store.
|
||||
If `true`, reads are duplicated between old and new meta stores
|
||||
(if [new meta store](#new-meta-store) is enabled).
|
||||
|
||||
**Default:** `true`
|
||||
|
||||
```sh
|
||||
influxd --new-meta-store-read-only=true
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## --no-tasks
|
||||
Disable the task scheduler.
|
||||
If problematic tasks prevent InfluxDB from starting, use this option to start
|
||||
InfluxDB without scheduling or executing tasks.
|
||||
|
||||
```sh
|
||||
influxd --no-tasks
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## --query-concurrency
|
||||
Number of queries allowed to execute concurrently.
|
||||
|
||||
**Default:** `10`
|
||||
|
||||
```sh
|
||||
influxd --query-concurrency=10
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## --query-initial-memory-bytes
|
||||
Initial bytes of memory allocated for a query.
|
||||
|
||||
**Default:** _equal to_ [query-memory-bytes](#query-memory-bytes)
|
||||
|
||||
```sh
|
||||
influxd --query-initial-memory-bytes=10485760
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## --query-max-memory-bytes
|
||||
Maximum total bytes of memory allowed for queries.
|
||||
|
||||
**Default:** _equal to_ [query-concurrency](#query-concurrency) × [query-memory-bytes](#query-memory-bytes)
|
||||
|
||||
```sh
|
||||
influxd --query-max-memory-bytes=104857600
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## --query-memory-bytes
|
||||
Maximum bytes of memory allowed for a single query.
|
||||
|
||||
**Default:** `10485760`
|
||||
|
||||
{{% note %}}
|
||||
Must be greater than or equal to [query-initial-memory-bytes](#query-initial-memory-bytes).
|
||||
{{% /note %}}
|
||||
|
||||
```sh
|
||||
influxd --query-memory-bytes=10485760
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## --query-queue-size
|
||||
Maximum number of queries allowed in execution queue.
|
||||
When queue limit is reached, new queries are rejected.
|
||||
|
||||
**Default:** `10`
|
||||
|
||||
```sh
|
||||
influxd --query-queue-size=10
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## --reporting-disabled
|
||||
Disables sending telemetry data to InfluxData.
|
||||
The [InfluxData telemetry](https://www.influxdata.com/telemetry) page provides
|
||||
|
|
|
|||
|
|
@ -0,0 +1,35 @@
|
|||
| Flag | Description | Input type |
|
||||
|:---- |:----------- | :--------: |
|
||||
| `--assets-path` | Override default assets by serving from a specific directory (developer mode) | string |
|
||||
| `--bolt-path` | Path to boltdb database (default `~/.influxdbv2/influxd.bolt`) | string |
|
||||
| `--e2e-testing` | Add /debug/flush endpoint to clear stores; used for end-to-end tests (default `false`) | |
|
||||
| `--engine-path` | Path to persistent engine files (default `~/.influxdbv2/engine`) | string |
|
||||
| `-h`, `--help` | Help for the `influxd` command | |
|
||||
| `--http-bind-address` | Bind address for the REST HTTP API (default `:9999`) | string |
|
||||
| `--log-level` | Supported log levels are debug, info, and error (default `info`) | string |
|
||||
| `--new-meta-store` | Enables the new meta store | |
|
||||
| `--new-meta-store-read-only` | Toggle read-only mode for the new meta store and duplicate reads between old and new store (default `true`) | |
|
||||
| `--no-tasks` | Disables the task scheduler | |
|
||||
| `--query-concurrency` | Number of queries allowed to execute concurrently (default `10`) | integer |
|
||||
| `--query-initial-memory-bytes` | Initial bytes of memory allocated for a query (default = `query-memory-bytes`) | integer |
|
||||
| `--query-max-memory-bytes` | Maximum total bytes of memory allowed for queries (default = `query-concurrency` × `query-memory-bytes`) | integer |
|
||||
| `--query-memory-bytes` | Maximum bytes of memory allowed for a single query (default `10485760`, must be >= `query-initial-memory-bytes`) | integer |
|
||||
| `--query-queue-size` | Maximum number of queries allowed in execution queue (default `10`) | integer |
|
||||
| `--reporting-disabled` | Disable sending telemetry data to **https:<nolink>//telemetry.influxdata.com** | |
|
||||
| `--secret-store` | Data store for secrets (bolt or vault) (default `bolt`) | string |
|
||||
| `--session-length` | TTL in minutes for newly created sessions (default `60`) | integer |
|
||||
| `--session-renew-disabled` | Disables automatically extending session TTL on request | |
|
||||
| `--store` | Data store for REST resources (bolt or memory) (default `bolt`) | string |
|
||||
| `--tls-cert` | Path to TLS certificate file | string |
|
||||
| `--tls-key` | Path to TLS private key file | string |
|
||||
| `--tracing-type` | Supported tracing types (log or jaeger) | string |
|
||||
| `--vault-addr ` | Address of the Vault server (example: `https://127.0.0.1:8200/`) | string |
|
||||
| `--vault-cacert` | Path to a PEM-encoded CA certificate file | string |
|
||||
| `--vault-capath` | Path to a directory of PEM-encoded CA certificate files | string |
|
||||
| `--vault-client-cert` | Path to a PEM-encoded client certificate | string |
|
||||
| `--vault-client-key` | Path to an unencrypted, PEM-encoded private key which corresponds to the matching client certificate | string |
|
||||
| `--vault-max-retries` | Maximum number of retries when encountering a 5xx error code (default `2`) | integer |
|
||||
| `--vault-client-timeout` | Vault client timeout (default `60s`) | duration |
|
||||
| `--vault-skip-verify` | Skip certificate verification when communicating with Vault | |
|
||||
| `--vault-tls-server-name` | Name to use as the SNI host when connecting to Vault via TLS | string |
|
||||
| `--vault-token` | Vault authentication token | string |
|
||||
Loading…
Reference in New Issue