Skip to content

Commit a9be343

Browse files
jstirnamanjstirnaman
authored
Merge pull request #5916 from influxdata/jts-fix-5915
fix-5915 Update influxdb3 serve options
2 parents 44fde6b + 5a5a291 commit a9be343

File tree

7 files changed

+350
-153
lines changed

7 files changed

+350
-153
lines changed

‎content/influxdb3/core/reference/cli/influxdb3/_index.md

Lines changed: 115 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,120 @@ menu:
88
parent: CLIs
99
name: influxdb3
1010
weight: 200
11-
source: /shared/influxdb3-cli/_index.md
1211
---
1312

14-
<!--
15-
The content of this file is at content/shared/influxdb3-cli/_index.md
16-
-->
13+
The `influxdb3` CLI runs and interacts with the {{< product-name >}} server.
14+
15+
## Usage
16+
17+
<!--pytest.mark.skip-->
18+
19+
```bash
20+
influxdb3 [GLOBAL-OPTIONS] [COMMAND]
21+
```
22+
23+
## Commands
24+
25+
| Command | Description |
26+
| :--------------------------------------------------------------| :---------------------------------- |
27+
| [create](/influxdb3/core/reference/cli/influxdb3/create/) | Create resources |
28+
| [delete](/influxdb3/core/reference/cli/influxdb3/delete/) | Delete resources |
29+
| [disable](/influxdb3/core/reference/cli/influxdb3/disable/) | Disable resources |
30+
| [enable](/influxdb3/core/reference/cli/influxdb3/enable/) | Enable resources |
31+
| [query](/influxdb3/core/reference/cli/influxdb3/query/) | Query {{% product-name %}} |
32+
| [serve](/influxdb3/core/reference/cli/influxdb3/serve/) | Run the {{% product-name %}} server |
33+
| [show](/influxdb3/core/reference/cli/influxdb3/show/) | List resources |
34+
| [test](/influxdb3/core/reference/cli/influxdb3/test/) | Test plugins |
35+
| [write](/influxdb3/core/reference/cli/influxdb3/write/) | Write to {{% product-name %}} |
36+
37+
## Global options
38+
39+
| Option | | Description |
40+
| :----- | :------------------------------------ | :------------------------------------------------------------------------------------------------ |
41+
| | `--num-threads` | Maximum number of IO runtime threads to use |
42+
| | `--io-runtime-type` | IO tokio runtime type (`current-thread`, `multi-thread` _(default)_, or `multi-thread-alt`) |
43+
| | `--io-runtime-disable-lifo-slot` | Disable LIFO slot of IO runtime |
44+
| | `--io-runtime-event-interval` | Number of scheduler ticks after which the IOtokio runtime scheduler will poll for external events |
45+
| | `--io-runtime-global-queue-interval` | Number of scheduler ticks after which the IO runtime scheduler will poll the global task queue |
46+
| | `--io-runtime-max-blocking-threads` | Limit for additional threads spawned by the IO runtime |
47+
| | `--io-runtime-max-io-events-per-tick` | Maximum number of events to be processed per tick by the tokio IO runtime |
48+
| | `--io-runtime-thread-keep-alive` | Custom timeout for a thread in the blocking pool of the tokio IO runtime |
49+
| | `--io-runtime-thread-priority` | Set thread priority tokio IO runtime workers |
50+
| `-h` | `--help` | Print help information |
51+
| `-V` | `--version` | Print version |
52+
53+
### Option environment variables
54+
55+
You can use the following environment variables to set `influxdb3` global options:
56+
57+
| Environment Variable | Option |
58+
| :-------------------------------------------- | :------------------------------------ |
59+
| `INFLUXDB3_NUM_THREADS` | `--num-threads` |
60+
| `INFLUXDB3_IO_RUNTIME_TYPE` | `--io-runtime-type` |
61+
| `INFLUXDB3_IO_RUNTIME_DISABLE_LIFO_SLOT` | `--io-runtime-disable-lifo-slot` |
62+
| `INFLUXDB3_IO_RUNTIME_EVENT_INTERVAL` | `--io-runtime-event-interval` |
63+
| `INFLUXDB3_IO_RUNTIME_GLOBAL_QUEUE_INTERVAL` | `--io-runtime-global-queue-interval` |
64+
| `INFLUXDB3_IO_RUNTIME_MAX_BLOCKING_THREADS` | `--io-runtime-max-blocking-threads` |
65+
| `INFLUXDB3_IO_RUNTIME_MAX_IO_EVENTS_PER_TICK` | `--io-runtime-max-io-events-per-tick` |
66+
| `INFLUXDB3_IO_RUNTIME_THREAD_KEEP_ALIVE` | `--io-runtime-thread-keep-alive` |
67+
| `INFLUXDB3_IO_RUNTIME_THREAD_PRIORITY` | `--io-runtime-thread-priority` |
68+
69+
70+
## Examples
71+
72+
In the examples below, replace
73+
{{% code-placeholder-key %}}`my-host-01`{{% /code-placeholder-key %}}:
74+
with a unique identifier for your {{< product-name >}} server.
75+
76+
{{% code-placeholders "my-host-01" %}}
77+
78+
### Run the InfluxDB 3 server
79+
80+
<!--pytest.mark.skip-->
81+
82+
```bash
83+
influxdb3 serve \
84+
--object-store file \
85+
--data-dir ~/.influxdb3 \
86+
--node-id my-host-01
87+
```
88+
89+
### Display short-form help for all commands
90+
91+
<!--pytest.mark.skip-->
92+
93+
```bash
94+
influxdb3 -h
95+
```
96+
97+
### Display long-form help for all commands
98+
99+
<!--pytest.mark.skip-->
100+
101+
```bash
102+
influxdb3 --help
103+
```
104+
105+
### Run the {{< product-name >}} server with extra verbose logging
106+
107+
<!--pytest.mark.skip-->
108+
109+
```bash
110+
influxdb3 serve -v \
111+
--object-store file \
112+
--data-dir ~/.influxdb3 \
113+
--node-id my-host-01
114+
```
115+
116+
### Run {{< product-name >}} with debug logging using LOG_FILTER
117+
118+
<!--pytest.mark.skip-->
119+
120+
```bash
121+
LOG_FILTER=debug influxdb3 serve \
122+
--object-store file \
123+
--data-dir ~/.influxdb3 \
124+
--node-id my-host-01
125+
```
126+
127+
{{% /code-placeholders %}}

‎content/influxdb3/core/reference/cli/influxdb3/serve.md

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,20 @@ The `influxdb3 serve` command starts the {{< product-name >}} server.
2121
influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
2222
```
2323

24+
## Required parameters
25+
26+
- **node-id**: A unique identifier for your server instance. Must be unique for any hosts sharing the same object store.
27+
- **object-store**: Determines where time series data is stored. _Default is `memory`_.
28+
- **data-dir**: Path for local file storage (required when using `--object-store file`).
29+
30+
> [!NOTE]
31+
> `--node-id` supports alphanumeric strings with optional hyphens.
32+
2433
## Options
2534

2635
| Option | | Description |
2736
| :--------------- | :--------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------ |
37+
| {{< req "\*" >}} | `--node-id` | _See [configuration options](/influxdb3/core/reference/config-options/#node-id)_ |
2838
| | `--object-store` | _See [configuration options](/influxdb3/core/reference/config-options/#object-store)_ |
2939
| | `--bucket` | _See [configuration options](/influxdb3/core/reference/config-options/#bucket)_ |
3040
| | `--data-dir` | _See [configuration options](/influxdb3/core/reference/config-options/#data-dir)_ |
@@ -80,9 +90,7 @@ influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
8090
| | `--wal-max-write-buffer-size` | _See [configuration options](/influxdb3/core/reference/config-options/#wal-max-write-buffer-size)_ |
8191
| | `--snapshotted-wal-files-to-keep` | _See [configuration options](/influxdb3/core/reference/config-options/#snapshotted-wal-files-to-keep)_ |
8292
| | `--query-log-size` | _See [configuration options](/influxdb3/core/reference/config-options/#query-log-size)_ |
83-
| | `--buffer-mem-limit-mb` | _See [configuration options](/influxdb3/core/reference/config-options/#buffer-mem-limit-mb)_ |
84-
| {{< req "\*" >}} | `--node-id` | _See [configuration options](/influxdb3/core/reference/config-options/#node-id)_ |
85-
| | `--parquet-mem-cache-size-mb` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-size-mb)_ |
93+
| | `--parquet-mem-cache-size` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-size)_ |
8694
| | `--parquet-mem-cache-prune-percentage` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-prune-percentage)_ |
8795
| | `--parquet-mem-cache-prune-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#parquet-mem-cache-prune-interval)_ |
8896
| | `--disable-parquet-mem-cache` | _See [configuration options](/influxdb3/core/reference/config-options/#disable-parquet-mem-cache)_ |
@@ -102,7 +110,7 @@ influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
102110

103111
You can use environment variables to define most `influxdb3 serve` options.
104112
For more information, see
105-
[Configuration options](/influxdb3/core/reference/config-options/).
113+
[Configuration options](/influxdb3/enterprise/reference/config-options/).
106114

107115
## Examples
108116

@@ -111,10 +119,10 @@ For more information, see
111119
- [Run InfluxDB 3 with debug logging using LOG_FILTER](#run-influxdb-3-with-debug-logging-using-log_filter)
112120

113121
In the examples below, replace
114-
{{% code-placeholder-key %}}`MY_HOST_ID`{{% /code-placeholder-key %}}:
115-
with a unique identifier for your {{< product-name >}} server.
122+
{{% code-placeholder-key %}}`my-host-01`{{% /code-placeholder-key %}}:
123+
with a unique string that identifies your {{< product-name >}} server.
116124

117-
{{% code-placeholders "MY_HOST_ID" %}}
125+
{{% code-placeholders "my-host-01" %}}
118126

119127
### Run the InfluxDB 3 server
120128

@@ -124,7 +132,7 @@ with a unique identifier for your {{< product-name >}} server.
124132
influxdb3 serve \
125133
--object-store file \
126134
--data-dir ~/.influxdb3 \
127-
--node-id MY_HOST_ID
135+
--node-id my-host-01
128136
```
129137

130138
### Run the InfluxDB 3 server with extra verbose logging
@@ -136,7 +144,7 @@ influxdb3 serve \
136144
--verbose \
137145
--object-store file \
138146
--data-dir ~/.influxdb3 \
139-
--node-id MY_HOST_ID
147+
--node-id my-host-01
140148
```
141149

142150
### Run InfluxDB 3 with debug logging using LOG_FILTER
@@ -147,7 +155,18 @@ influxdb3 serve \
147155
LOG_FILTER=debug influxdb3 serve \
148156
--object-store file \
149157
--data-dir ~/.influxdb3 \
150-
--node-id MY_HOST_ID
158+
--node-id my-host-01
151159
```
152160

153161
{{% /code-placeholders %}}
162+
163+
164+
## Troubleshooting
165+
166+
### Common Issues
167+
168+
- **Error: "Failed to connect to object store"**
169+
Verify your `--object-store` setting and ensure all required parameters for that storage type are provided.
170+
171+
- **Permission errors when using S3, Google Cloud, or Azure storage**
172+
Check that your authentication credentials are correct and have sufficient permissions.

‎content/influxdb3/core/reference/config-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ environment variables.
2727
influxdb3 serve \
2828
--object-store file \
2929
--data-dir ~/.influxdb3 \
30-
--node-id my-host \
30+
--node-id NODE_ID \
3131
--log-filter info \
3232
--max-http-request-size 20971520 \
3333
--aws-allow-http

‎content/influxdb3/enterprise/reference/cli/influxdb3/_index.md

Lines changed: 122 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,127 @@ menu:
88
parent: CLIs
99
name: influxdb3
1010
weight: 200
11-
source: /shared/influxdb3-cli/_index.md
1211
---
1312

14-
<!--
15-
The content of this file is at content/shared/influxdb3-cli/_index.md
16-
-->
13+
The `influxdb3` CLI runs and interacts with the {{< product-name >}} server.
14+
15+
## Usage
16+
17+
<!--pytest.mark.skip-->
18+
19+
```bash
20+
influxdb3 [GLOBAL-OPTIONS] [COMMAND]
21+
```
22+
23+
## Commands
24+
25+
| Command | Description |
26+
| :--------------------------------------------------------------| :---------------------------------- |
27+
| [create](/influxdb3/enterprise/reference/cli/influxdb3/create/) | Create resources |
28+
| [delete](/influxdb3/enterprise/reference/cli/influxdb3/delete/) | Delete resources |
29+
| [disable](/influxdb3/enterprise/reference/cli/influxdb3/disable/) | Disable resources |
30+
| [enable](/influxdb3/enterprise/reference/cli/influxdb3/enable/) | Enable resources |
31+
| [query](/influxdb3/enterprise/reference/cli/influxdb3/query/) | Query {{% product-name %}} |
32+
| [serve](/influxdb3/enterprise/reference/cli/influxdb3/serve/) | Run the {{% product-name %}} server |
33+
| [show](/influxdb3/enterprise/reference/cli/influxdb3/show/) | List resources |
34+
| [test](/influxdb3/enterprise/reference/cli/influxdb3/test/) | Test plugins |
35+
| [write](/influxdb3/enterprise/reference/cli/influxdb3/write/) | Write to {{% product-name %}} |
36+
37+
## Global options
38+
39+
| Option | | Description |
40+
| :----- | :------------------------------------ | :------------------------------------------------------------------------------------------------ |
41+
| | `--num-threads` | Maximum number of IO runtime threads to use |
42+
| | `--io-runtime-type` | IO tokio runtime type (`current-thread`, `multi-thread` _(default)_, or `multi-thread-alt`) |
43+
| | `--io-runtime-disable-lifo-slot` | Disable LIFO slot of IO runtime |
44+
| | `--io-runtime-event-interval` | Number of scheduler ticks after which the IOtokio runtime scheduler will poll for external events |
45+
| | `--io-runtime-global-queue-interval` | Number of scheduler ticks after which the IO runtime scheduler will poll the global task queue |
46+
| | `--io-runtime-max-blocking-threads` | Limit for additional threads spawned by the IO runtime |
47+
| | `--io-runtime-max-io-events-per-tick` | Maximum number of events to be processed per tick by the tokio IO runtime |
48+
| | `--io-runtime-thread-keep-alive` | Custom timeout for a thread in the blocking pool of the tokio IO runtime |
49+
| | `--io-runtime-thread-priority` | Set thread priority tokio IO runtime workers |
50+
| `-h` | `--help` | Print help information |
51+
| `-V` | `--version` | Print version |
52+
53+
### Option environment variables
54+
55+
You can use the following environment variables to set `influxdb3` global options:
56+
57+
| Environment Variable | Option |
58+
| :-------------------------------------------- | :------------------------------------ |
59+
| `INFLUXDB3_NUM_THREADS` | `--num-threads` |
60+
| `INFLUXDB3_IO_RUNTIME_TYPE` | `--io-runtime-type` |
61+
| `INFLUXDB3_IO_RUNTIME_DISABLE_LIFO_SLOT` | `--io-runtime-disable-lifo-slot` |
62+
| `INFLUXDB3_IO_RUNTIME_EVENT_INTERVAL` | `--io-runtime-event-interval` |
63+
| `INFLUXDB3_IO_RUNTIME_GLOBAL_QUEUE_INTERVAL` | `--io-runtime-global-queue-interval` |
64+
| `INFLUXDB3_IO_RUNTIME_MAX_BLOCKING_THREADS` | `--io-runtime-max-blocking-threads` |
65+
| `INFLUXDB3_IO_RUNTIME_MAX_IO_EVENTS_PER_TICK` | `--io-runtime-max-io-events-per-tick` |
66+
| `INFLUXDB3_IO_RUNTIME_THREAD_KEEP_ALIVE` | `--io-runtime-thread-keep-alive` |
67+
| `INFLUXDB3_IO_RUNTIME_THREAD_PRIORITY` | `--io-runtime-thread-priority` |
68+
69+
70+
## Examples
71+
72+
In the examples below, replace the following:
73+
74+
- {{% code-placeholder-key %}}`my-host-01`{{% /code-placeholder-key %}}:
75+
a unique identifier for your {{< product-name >}} server.
76+
- {{% code-placeholder-key %}}`my-cluster-01`{{% /code-placeholder-key %}}:
77+
a unique identifier for your {{< product-name >}} cluster.
78+
The value you use must be different from `--node-id` values in the cluster.
79+
80+
{{% code-placeholders "my-host-01|my-cluster-01" %}}
81+
82+
### Run the InfluxDB 3 server
83+
84+
<!--pytest.mark.skip-->
85+
86+
```bash
87+
influxdb3 serve \
88+
--object-store file \
89+
--data-dir ~/.influxdb3 \
90+
--node-id my-host-01 \
91+
--cluster-id my-cluster-01
92+
```
93+
94+
### Display short-form help for all commands
95+
96+
<!--pytest.mark.skip-->
97+
98+
```bash
99+
influxdb3 -h
100+
```
101+
102+
### Display long-form help for all commands
103+
104+
<!--pytest.mark.skip-->
105+
106+
```bash
107+
influxdb3 --help
108+
```
109+
110+
### Run the {{< product-name >}} server with extra verbose logging
111+
112+
<!--pytest.mark.skip-->
113+
114+
```bash
115+
influxdb3 serve -v \
116+
--object-store file \
117+
--data-dir ~/.influxdb3 \
118+
--node-id my-host-01 \
119+
--cluster-id my-cluster-01
120+
```
121+
122+
### Run {{< product-name >}} with debug logging using LOG_FILTER
123+
124+
<!--pytest.mark.skip-->
125+
126+
```bash
127+
LOG_FILTER=debug influxdb3 serve \
128+
--object-store file \
129+
--data-dir ~/.influxdb3 \
130+
--node-id my-host-01 \
131+
--cluster-id my-cluster-01
132+
```
133+
134+
{{% /code-placeholders %}}

0 commit comments

Comments
 (0)