Skip to content

Commit a3f06ce

Browse files
sandersonjstirnaman
sanderson
and
jstirnaman
authored
Add missing influxdb3 serve configuration options (#5822)
* add missing influxdb3 serve configuration options * Apply suggestions from code review Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com> --------- Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
1 parent fb665e2 commit a3f06ce

File tree

4 files changed

+121
-7
lines changed

4 files changed

+121
-7
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,8 @@ influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
9090
| | `--distinct-cache-eviction-interval` | _See [configuration options](/influxdb3/core/reference/config-options/#distinct-cache-eviction-interval)_ |
9191
| | `--plugin-dir` | _See [configuration options](/influxdb3/core/reference/config-options/#plugin-dir)_ |
9292
| | `--force-snapshot-mem-threshold` | _See [configuration options](/influxdb3/core/reference/config-options/#force-snapshot-mem-threshold)_ |
93+
| | `--virtual-env-location` | _See [configuration options](/influxdb3/core/reference/config-options/#virtual-env-location)_ |
94+
| | `--package-manager` | _See [configuration options](/influxdb3/core/reference/config-options/#package-manager)_ |
9395
| | `--query-file-limit` | _See [configuration options](/influxdb3/core/reference/config-options/#query-file-limit)_ |
9496

9597
{{< caption >}}

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

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,10 @@ influxdb3 serve
127127
- [disable-parquet-mem-cache](#disable-parquet-mem-cache)
128128
- [last-cache-eviction-interval](#last-cache-eviction-interval)
129129
- [distinct-cache-eviction-interval](#distinct-cache-eviction-interval)
130-
- [Plugins](#plugins)
130+
- [Processing engine](#processing-engine)
131131
- [plugin-dir](#plugin-dir)
132+
- [virtual-env-location](#virtual-env-location)
133+
- [package-manager](#package-manager)
132134

133135
---
134136

@@ -1017,9 +1019,11 @@ expressed as a human-readable time--for example: `20s`, `1m`, `1h`.
10171019

10181020
---
10191021

1020-
### Plugins
1022+
### Processing engine
10211023

10221024
- [plugin-dir](#plugin-dir)
1025+
- [virtual-env-location](#virtual-env-location)
1026+
- [package-manager](#package-manager)
10231027

10241028
#### plugin-dir
10251029

@@ -1029,3 +1033,25 @@ Specifies the local directory that contains Python plugins and their test files.
10291033
| :--------------------- | :--------------------- |
10301034
| `--plugin-dir` | `INFLUXDB3_PLUGIN_DIR` |
10311035

1036+
---
1037+
1038+
#### virtual-env-location
1039+
1040+
Specifies the location of the Python virtual environment that the processing
1041+
engine uses.
1042+
1043+
| influxdb3 serve option | Environment variable |
1044+
| :----------------------- | :--------------------- |
1045+
| `--virtual-env-location` | `VIRTUAL_ENV_LOCATION` |
1046+
1047+
---
1048+
1049+
#### package-manager
1050+
1051+
Specifies the Python package manager that the processing engine uses.
1052+
1053+
**Default:** `10s`
1054+
1055+
| influxdb3 serve option | Environment variable |
1056+
| :--------------------- | :------------------- |
1057+
| `--package-manager` | `PACKAGE_MANAGER` |

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
7676
| | `--wal-flush-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#wal-flush-interval)_ |
7777
| | `--wal-snapshot-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#wal-snapshot-size)_ |
7878
| | `--wal-max-write-buffer-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#wal-max-write-buffer-size)_ |
79+
| | `--snapshotted-wal-files-to-keep` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#snapshotted-wal-files-to-keep)_ |
7980
| | `--query-log-size` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#query-log-size)_ |
8081
| | `--buffer-mem-limit-mb` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#buffer-mem-limit-mb)_ |
8182
| {{< req "\*" >}} | `--node-id` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#node-id)_ |
@@ -89,14 +90,20 @@ influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
8990
| | `--compaction-max-num-files-per-plan` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-max-num-files-per-plan)_ |
9091
| | `--compaction-gen2-duration` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-gen2-duration)_ |
9192
| | `--compaction-multipliers` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#compaction-multipliers)_ |
93+
| | `--license-email` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#license-email)_ |
9294
| | `--preemptive-cache-age` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#preemptive-cache-age)_ |
9395
| | `--parquet-mem-cache-size-mb` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#parquet-mem-cache-size-mb)_ |
9496
| | `--parquet-mem-cache-prune-percentage` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#parquet-mem-cache-prune-percentage)_ |
9597
| | `--parquet-mem-cache-prune-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#parquet-mem-cache-prune-interval)_ |
9698
| | `--disable-parquet-mem-cache` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#disable-parquet-mem-cache)_ |
99+
| | `--parquet-mem-cache-query-path-duration` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#parquet-mem-cache-query-path-duration)_ |
97100
| | `--last-cache-eviction-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#last-cache-eviction-interval)_ |
98101
| | `--distinct-cache-eviction-interval` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#distinct-cache-eviction-interval)_ |
99102
| | `--plugin-dir` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#plugin-dir)_ |
103+
| | `--force-snapshot-mem-threshold` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#force-snapshot-mem-threshold)_ |
104+
| | `--virtual-env-location` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#virtual-env-location)_ |
105+
| | `--package-manager` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#package-manager)_ |
106+
| | `--query-file-limit` | _See [configuration options](/influxdb3/enterprise/reference/config-options/#query-file-limit)_ |
100107

101108
{{< caption >}}
102109
{{< req text="\* Required options" >}}

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

Lines changed: 84 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ influxdb3 serve
5555
- [data-dir](#data-dir)
5656
- [node-id](#node-id)
5757
- [mode](#mode)
58+
- [license-email](#license-email)
59+
- [query-file-limit](#query-file-limit)
5860
- [AWS](#aws)
5961
- [aws-access-key-id](#aws-access-key-id)
6062
- [aws-secret-access-key](#aws-secret-access-key)
@@ -135,11 +137,14 @@ influxdb3 serve
135137
- [parquet-mem-cache-prune-percentage](#parquet-mem-cache-prune-percentage)
136138
- [parquet-mem-cache-prune-interval](#parquet-mem-cache-prune-interval)
137139
- [disable-parquet-mem-cache](#disable-parquet-mem-cache)
140+
- [parquet-mem-cache-query-path-duration](#parquet-mem-cache-query-path-duration)
138141
- [last-cache-eviction-interval](#last-cache-eviction-interval)
139142
- [distinct-cache-eviction-interval](#distinct-cache-eviction-interval)
140-
- [Plugins](#plugins)
143+
- [Processing engine](#processing-engine)
141144
- [plugin-dir](#plugin-dir)
142-
145+
- [virtual-env-location](#virtual-env-location)
146+
- [package-manager](#package-manager)
147+
143148
---
144149

145150
### General
@@ -149,6 +154,8 @@ influxdb3 serve
149154
- [data-dir](#data-dir)
150155
- [node-id](#node-id)
151156
- [mode](#mode)
157+
- [license-email](#license-email)
158+
- [query-file-limit](#query-file-limit)
152159

153160
#### object-store
154161

@@ -208,6 +215,40 @@ This option supports the following values:
208215

209216
---
210217

218+
#### license-email
219+
220+
Specifies the email address to associate with your {{< product-name >}} license
221+
and automatically responds to the interactive email prompt when the server starts.
222+
223+
| influxdb3 serve option | Environment variable |
224+
| :--------------------- | :----------------------------------- |
225+
| `--license-email` | `INFLUXDB3_ENTERPRISE_LICENSE_EMAIL` |
226+
227+
---
228+
229+
#### query-file-limit
230+
231+
Limits the number of Parquet files a query can access.
232+
If a query attempts to read more than this limit, InfluxDB returns an error.
233+
234+
**Default:** `432`
235+
236+
You can increase this limit to allow more files to be queried, but be aware of
237+
the following side-effects:
238+
239+
- Degraded query performance for queries that read more Parquet files
240+
- Increased memory usage
241+
- Your system potentially killing the `influxdb3` process due to Out-of-Memory
242+
(OOM) errors
243+
- If using object storage to store data, many GET requests to access the data
244+
(as many as 2 requests per file)
245+
246+
| influxdb3 serve option | Environment variable |
247+
| :--------------------- | :--------------------------- |
248+
| `--query-file-limit` | `INFLUXDB3_QUERY_FILE_LIMIT` |
249+
250+
---
251+
211252
### AWS
212253

213254
- [aws-access-key-id](#aws-access-key-id)
@@ -1051,6 +1092,7 @@ compactor can merge into larger generations.
10511092
- [parquet-mem-cache-prune-percentage](#parquet-mem-cache-prune-percentage)
10521093
- [parquet-mem-cache-prune-interval](#parquet-mem-cache-prune-interval)
10531094
- [disable-parquet-mem-cache](#disable-parquet-mem-cache)
1095+
- [parquet-mem-cache-query-path-duration](#parquet-mem-cache-query-path-duration)
10541096
- [last-cache-eviction-interval](#last-cache-eviction-interval)
10551097
- [distinct-cache-eviction-interval](#distinct-cache-eviction-interval)
10561098

@@ -1113,10 +1155,23 @@ Disables the in-memory Parquet cache. By default, the cache is enabled.
11131155

11141156
---
11151157

1158+
#### parquet-mem-cache-query-path-duration
1159+
1160+
Specifies the duration to check if Parquet files pulled in query path
1161+
require caching, expressed as a human-readable duration (starting from _now_)--for example: `5h`, `3d`.
1162+
1163+
**Default:** `5h`
1164+
1165+
| influxdb3 serve option | Environment variable |
1166+
| :---------------------------- | :------------------------------------ |
1167+
| `--parquet-mem-cache-query-path-duration` | `INFLUXDB3_PARQUET_MEM_CACHE_QUERY_PATH_DURATION` |
1168+
1169+
---
1170+
11161171
#### last-cache-eviction-interval
11171172

11181173
Specifies the interval to evict expired entries from the Last-N-Value cache,
1119-
expressed as a human-readable time--for example: `20s`, `1m`, `1h`.
1174+
expressed as a human-readable duration--for example: `20s`, `1m`, `1h`.
11201175

11211176
**Default:** `10s`
11221177

@@ -1129,7 +1184,7 @@ expressed as a human-readable time--for example: `20s`, `1m`, `1h`.
11291184
#### distinct-cache-eviction-interval
11301185

11311186
Specifies the interval to evict expired entries from the distinct value cache,
1132-
expressed as a human-readable time--for example: `20s`, `1m`, `1h`.
1187+
expressed as a human-readable duration--for example: `20s`, `1m`, `1h`.
11331188

11341189
**Default:** `10s`
11351190

@@ -1139,9 +1194,11 @@ expressed as a human-readable time--for example: `20s`, `1m`, `1h`.
11391194

11401195
---
11411196

1142-
### Plugins
1197+
### Processing engine
11431198

11441199
- [plugin-dir](#plugin-dir)
1200+
- [virtual-env-location](#virtual-env-location)
1201+
- [package-manager](#package-manager)
11451202

11461203
#### plugin-dir
11471204

@@ -1151,3 +1208,25 @@ Specifies the local directory that contains Python plugins and their test files.
11511208
| :--------------------- | :--------------------- |
11521209
| `--plugin-dir` | `INFLUXDB3_PLUGIN_DIR` |
11531210

1211+
---
1212+
1213+
#### virtual-env-location
1214+
1215+
Specifies the location of the Python virtual environment that the processing
1216+
engine uses.
1217+
1218+
| influxdb3 serve option | Environment variable |
1219+
| :----------------------- | :--------------------- |
1220+
| `--virtual-env-location` | `VIRTUAL_ENV_LOCATION` |
1221+
1222+
---
1223+
1224+
#### package-manager
1225+
1226+
Specifies the Python package manager that the processing engine uses.
1227+
1228+
**Default:** `10s`
1229+
1230+
| influxdb3 serve option | Environment variable |
1231+
| :--------------------- | :------------------- |
1232+
| `--package-manager` | `PACKAGE_MANAGER` |

0 commit comments

Comments
 (0)