Skip to content

Influxdb3 config options #6419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 20, 2025
+214 −179
Merged

Influxdb3 config options #6419

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5c19af9
docs(cli): fix global vs serve-specific flag documentation
jstirnaman Sep 25, 2025
d21a61e
docs(cli): remove Tokio runtime options from CLI index pages
jstirnaman Sep 25, 2025
463114b
Merge branch 'master' into influxdb3-config-options
jstirnaman Sep 25, 2025
f8c041e
Merge branch 'master' into influxdb3-config-options
jstirnaman Oct 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 21 additions & 32 deletions content/influxdb3/core/reference/cli/influxdb3/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,36 +37,13 @@ influxdb3 [GLOBAL-OPTIONS] [COMMAND]

## Global options

| Option | | Description |
| :----- | :------------------------------------ | :------------------------------------------------------------------------------------------------ |
| | `--num-threads` | Maximum number of IO runtime threads to use |
| | `--io-runtime-type` | IO tokio runtime type (`current-thread`, `multi-thread` _(default)_, or `multi-thread-alt`) |
| | `--io-runtime-disable-lifo-slot` | Disable LIFO slot of IO runtime |
| | `--io-runtime-event-interval` | Number of scheduler ticks after which the IOtokio runtime scheduler will poll for external events |
| | `--io-runtime-global-queue-interval` | Number of scheduler ticks after which the IO runtime scheduler will poll the global task queue |
| | `--io-runtime-max-blocking-threads` | Limit for additional threads spawned by the IO runtime |
| | `--io-runtime-max-io-events-per-tick` | Maximum number of events to be processed per tick by the tokio IO runtime |
| | `--io-runtime-thread-keep-alive` | Custom timeout for a thread in the blocking pool of the tokio IO runtime |
| | `--io-runtime-thread-priority` | Set thread priority tokio IO runtime workers |
| `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information including runtime configuration options |
| `-V` | `--version` | Print version |

### Option environment variables

You can use the following environment variables to set `influxdb3` global options:

| Environment Variable | Option |
| :-------------------------------------------- | :------------------------------------ |
| `INFLUXDB3_NUM_THREADS` | `--num-threads` |
| `INFLUXDB3_IO_RUNTIME_TYPE` | `--io-runtime-type` |
| `INFLUXDB3_IO_RUNTIME_DISABLE_LIFO_SLOT` | `--io-runtime-disable-lifo-slot` |
| `INFLUXDB3_IO_RUNTIME_EVENT_INTERVAL` | `--io-runtime-event-interval` |
| `INFLUXDB3_IO_RUNTIME_GLOBAL_QUEUE_INTERVAL` | `--io-runtime-global-queue-interval` |
| `INFLUXDB3_IO_RUNTIME_MAX_BLOCKING_THREADS` | `--io-runtime-max-blocking-threads` |
| `INFLUXDB3_IO_RUNTIME_MAX_IO_EVENTS_PER_TICK` | `--io-runtime-max-io-events-per-tick` |
| `INFLUXDB3_IO_RUNTIME_THREAD_KEEP_ALIVE` | `--io-runtime-thread-keep-alive` |
| `INFLUXDB3_IO_RUNTIME_THREAD_PRIORITY` | `--io-runtime-thread-priority` |
| Option | | Description |
| :----- | :---------------- | :-------------------------------------------------------------------- |
| `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information including runtime configuration options |
| `-V` | `--version` | Print version |

For advanced global configuration options (including `--num-io-threads` and other runtime settings), see [Configuration options](/influxdb3/core/reference/config-options/#global-configuration-options).


## Examples
Expand All @@ -88,6 +65,17 @@ influxdb3 serve \
--node-id my-host-01
```

### Run the InfluxDB 3 server with custom IO threads

<!--pytest.mark.skip-->

```bash
influxdb3 --num-io-threads=8 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01
```

### Display short-form help for all commands

<!--pytest.mark.skip-->
Expand All @@ -109,10 +97,11 @@ influxdb3 --help
<!--pytest.mark.skip-->

```bash
influxdb3 serve -v \
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01
--node-id my-host-01 \
--verbose
```

### Run {{% product-name %}} with debug logging using LOG_FILTER
Expand Down
13 changes: 11 additions & 2 deletions content/influxdb3/core/reference/cli/influxdb3/serve.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,16 @@ influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
> [!NOTE]
> `--node-id` supports alphanumeric strings with optional hyphens.

> [!Important]
> #### Global configuration options
> Some configuration options (like [`--num-io-threads`](/influxdb3/core/reference/config-options/#num-io-threads)) are **global** and must be specified **before** the `serve` command:
>
> ```bash
> influxdb3 --num-io-threads=8 serve --node-id=node0 --object-store=file --verbose
> ```
>
> See [Global configuration options](/influxdb3/core/reference/config-options/#global-configuration-options) for the complete list.

## Options

| Option | | Description |
Expand Down Expand Up @@ -116,7 +126,6 @@ influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
| | `--traces-jaeger-debug-name` | _See [configuration options](/influxdb3/core/reference/config-options/#traces-jaeger-debug-name)_ |
| | `--traces-jaeger-max-msgs-per-second` | _See [configuration options](/influxdb3/core/reference/config-options/#traces-jaeger-max-msgs-per-second)_ |
| | `--traces-jaeger-tags` | _See [configuration options](/influxdb3/core/reference/config-options/#traces-jaeger-tags)_ |
| `-v` | `--verbose` | Enable verbose output |
| | `--virtual-env-location` | _See [configuration options](/influxdb3/core/reference/config-options/#virtual-env-location)_ |
| | `--wal-flush-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#wal-flush-interval)_ |
| | `--wal-max-write-buffer-size` | _See [configuration options](/influxdb3/core/reference/config-options/#wal-max-write-buffer-size)_ |
Expand Down Expand Up @@ -164,10 +173,10 @@ influxdb3 serve \

```bash
influxdb3 serve \
--verbose \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01
--verbose
```

### Run InfluxDB 3 with debug logging using LOG_FILTER
Expand Down
54 changes: 22 additions & 32 deletions content/influxdb3/enterprise/reference/cli/influxdb3/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,36 +37,13 @@ influxdb3 [GLOBAL-OPTIONS] [COMMAND]

## Global options

| Option | | Description |
| :----- | :------------------------------------ | :------------------------------------------------------------------------------------------------ |
| | `--num-threads` | Maximum number of IO runtime threads to use |
| | `--io-runtime-type` | IO tokio runtime type (`current-thread`, `multi-thread` _(default)_, or `multi-thread-alt`) |
| | `--io-runtime-disable-lifo-slot` | Disable LIFO slot of IO runtime |
| | `--io-runtime-event-interval` | Number of scheduler ticks after which the IOtokio runtime scheduler will poll for external events |
| | `--io-runtime-global-queue-interval` | Number of scheduler ticks after which the IO runtime scheduler will poll the global task queue |
| | `--io-runtime-max-blocking-threads` | Limit for additional threads spawned by the IO runtime |
| | `--io-runtime-max-io-events-per-tick` | Maximum number of events to be processed per tick by the tokio IO runtime |
| | `--io-runtime-thread-keep-alive` | Custom timeout for a thread in the blocking pool of the tokio IO runtime |
| | `--io-runtime-thread-priority` | Set thread priority tokio IO runtime workers |
| `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information |
| `-V` | `--version` | Print version |

### Option environment variables

You can use the following environment variables to set `influxdb3` global options:

| Environment Variable | Option |
| :-------------------------------------------- | :------------------------------------ |
| `INFLUXDB3_NUM_THREADS` | `--num-threads` |
| `INFLUXDB3_IO_RUNTIME_TYPE` | `--io-runtime-type` |
| `INFLUXDB3_IO_RUNTIME_DISABLE_LIFO_SLOT` | `--io-runtime-disable-lifo-slot` |
| `INFLUXDB3_IO_RUNTIME_EVENT_INTERVAL` | `--io-runtime-event-interval` |
| `INFLUXDB3_IO_RUNTIME_GLOBAL_QUEUE_INTERVAL` | `--io-runtime-global-queue-interval` |
| `INFLUXDB3_IO_RUNTIME_MAX_BLOCKING_THREADS` | `--io-runtime-max-blocking-threads` |
| `INFLUXDB3_IO_RUNTIME_MAX_IO_EVENTS_PER_TICK` | `--io-runtime-max-io-events-per-tick` |
| `INFLUXDB3_IO_RUNTIME_THREAD_KEEP_ALIVE` | `--io-runtime-thread-keep-alive` |
| `INFLUXDB3_IO_RUNTIME_THREAD_PRIORITY` | `--io-runtime-thread-priority` |
| Option | | Description |
| :----- | :---------------- | :-------------------------------------------------------------------- |
| `-h` | `--help` | Print help information |
| | `--help-all` | Print detailed help information including runtime configuration options |
| `-V` | `--version` | Print version |

For advanced global configuration options (including `--num-io-threads` and other runtime settings), see [Configuration options](/influxdb3/enterprise/reference/config-options/#global-configuration-options).


## Examples
Expand All @@ -93,6 +70,18 @@ influxdb3 serve \
--cluster-id my-cluster-01
```

### Run the InfluxDB 3 server with custom IO threads

<!--pytest.mark.skip-->

```bash
influxdb3 --num-io-threads=8 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01 \
--cluster-id my-cluster-01
```

### Display short-form help for all commands

<!--pytest.mark.skip-->
Expand All @@ -114,11 +103,12 @@ influxdb3 --help
<!--pytest.mark.skip-->

```bash
influxdb3 serve -v \
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01 \
--cluster-id my-cluster-01
--cluster-id my-cluster-01 \
--verbose
```

### Run {{% product-name %}} with debug logging using LOG_FILTER
Expand Down
14 changes: 12 additions & 2 deletions content/influxdb3/enterprise/reference/cli/influxdb3/serve.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,16 @@ influxdb3 serve [OPTIONS] \
> [!NOTE]
> `--node-id` and `--cluster-id` support alphanumeric strings with optional hyphens.

> [!Important]
> #### Global configuration options
> Some configuration options (like [`--num-io-threads`](/influxdb3/enterprise/reference/config-options/#num-io-threads)) are **global** and must be specified **before** the `serve` command:
>
> ```bash
> influxdb3 --num-io-threads=8 serve --node-id=node0 --cluster-id=cluster0 --verbose
> ```
>
> See [Global configuration options](/influxdb3/enterprise/reference/config-options/#global-configuration-options) for the complete list.

## Options

| Option | | Description |
Expand Down Expand Up @@ -100,6 +110,7 @@ influxdb3 serve [OPTIONS] \
| {{< req "\*" >}} | `--node-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#node-id)_ |
| | `--node-id-from-env` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#node-id-from-env)_ |
| | `--num-cores` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#num-cores)_ |
| | `--num-datafusion-threads` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#num-datafusion-threads)_ |
| | `--num-database-limit` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#num-database-limit)_ |
| | `--num-table-limit` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#num-table-limit)_ |
| | `--num-total-columns-per-table-limit` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#num-total-columns-per-table-limit)_ |
Expand Down Expand Up @@ -140,7 +151,6 @@ influxdb3 serve [OPTIONS] \
| | `--traces-jaeger-max-msgs-per-second` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#traces-jaeger-max-msgs-per-second)_ |
| | `--traces-jaeger-tags` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#traces-jaeger-tags)_ |
| | `--use-pacha-tree` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#use-pacha-tree)_ |
| `-v` | `--verbose` | Enable verbose output |
| | `--virtual-env-location` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#virtual-env-location)_ |
| | `--wait-for-running-ingestor` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#wait-for-running-ingestor)_ |
| | `--wal-flush-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#wal-flush-interval)_ |
Expand Down Expand Up @@ -220,11 +230,11 @@ influxdb3 serve \

```bash
influxdb3 serve \
--verbose \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01 \
--cluster-id my-cluster-01
--verbose
```

### Run InfluxDB 3 with debug logging using LOG_FILTER
Expand Down
Loading
Loading