Skip to content

Commit 68b6bc9

Browse files
committed
feat(influxdb3): add runtime architecture, metrics monitoring, and performance tuning documentation
- Add comprehensive runtime architecture documentation covering thread pools, resource allocation, and concurrency model - Add metrics monitoring guide with Prometheus endpoint configuration and key metrics reference - Add performance tuning documentation with thread pool optimization, memory settings, and resource planning - Add clustering configuration documentation for InfluxDB 3 Enterprise - Update CLI serve command documentation with new runtime and metrics flags This addresses the need for detailed documentation on: - How InfluxDB 3 manages threads and system resources - How to monitor and observe InfluxDB 3 performance metrics - How to tune runtime parameters for optimal performance - How to configure clustering in Enterprise deployments Closes #6403
1 parent aea3d7b commit 68b6bc9

File tree

19 files changed

+2966
-7
lines changed

19 files changed

+2966
-7
lines changed

.github/instructions/content.instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,4 +219,4 @@ For the complete shortcodes reference, see `/.github/instructions/shortcodes-ref
219219
- Format code examples to fit within 80 characters
220220
- Use long options in command line examples (`--option` instead of `-o`)
221221
- Use GitHub callout syntax for notes and warnings
222-
- Image naming: `project/version-context-description.png`
222+
- Image naming: `project/version-context-description.png`
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Monitor metrics
3+
seotitle: Monitor InfluxDB 3 Core metrics
4+
description: >
5+
Access and understand Prometheus-format metrics exposed by {{< product-name >}}
6+
to monitor system performance, resource usage, and operational health.
7+
menu:
8+
influxdb3_core:
9+
parent: Administer InfluxDB
10+
name: Monitor metrics
11+
weight: 105
12+
influxdb3/core/tags: [monitoring, metrics, prometheus, observability, operations]
13+
related:
14+
- /influxdb3/core/reference/internals/runtime-architecture/
15+
- /influxdb3/core/admin/performance-tuning/
16+
- /influxdb3/core/reference/telemetry/
17+
source: /shared/influxdb3-admin/monitor-metrics.md
18+
---
19+
20+
<!--
21+
//SOURCE - content/shared/influxdb3-admin/monitor-metrics.md
22+
-->
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Performance tuning
3+
seotitle: InfluxDB 3 Core performance tuning and optimization
4+
description: >
5+
Optimize InfluxDB 3 Core performance by tuning thread allocation,
6+
memory settings, and other configuration options for your specific workload.
7+
weight: 205
8+
menu:
9+
influxdb3_core:
10+
parent: Administer InfluxDB
11+
name: Performance tuning
12+
related:
13+
- /influxdb3/core/reference/internals/runtime-architecture/
14+
- /influxdb3/core/reference/config-options/
15+
- /influxdb3/core/admin/query-system-data/
16+
source: /shared/influxdb3-admin/performance-tuning.md
17+
---
18+
19+
<!--
20+
The content of this file is located at
21+
//SOURCE - content/shared/influxdb3-admin/performance-tuning.md
22+
-->

content/influxdb3/core/object-storage/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ menu:
77
influxdb3_core:
88
name: Configure object storage
99
parent: Administer InfluxDB
10-
weight: 110
10+
weight: 100
1111
influxdb3/core/tags: [object storage, S3]
1212
related:
1313
- /influxdb3/core/reference/config-options/

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>
8383
| | `--log-filter` | _See [configuration options](/influxdb3/core/reference/config-options/#log-filter)_ |
8484
| | `--log-format` | _See [configuration options](/influxdb3/core/reference/config-options/#log-format)_ |
8585
| | `--max-http-request-size` | _See [configuration options](/influxdb3/core/reference/config-options/#max-http-request-size)_ |
86+
| | `--num-io-threads` | _See [configuration options](/influxdb3/core/reference/config-options/#num-io-threads)_ |
8687
| | `--object-store-cache-endpoint` | _See [configuration options](/influxdb3/core/reference/config-options/#object-store-cache-endpoint)_ |
8788
| | `--object-store-connection-limit` | _See [configuration options](/influxdb3/core/reference/config-options/#object-store-connection-limit)_ |
8889
| | `--object-store-http2-max-frame-size` | _See [configuration options](/influxdb3/core/reference/config-options/#object-store-http2-max-frame-size)_ |
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Runtime thread architecture
3+
seotitle: InfluxDB 3 Core runtime thread architecture
4+
description: >
5+
Learn how InfluxDB 3 Core allocates and manages runtime threads between IO and DataFusion thread pools
6+
for optimal performance.
7+
weight: 102
8+
menu:
9+
influxdb3_core:
10+
parent: Core internals
11+
name: Runtime architecture
12+
influxdb3/core/tags: [architecture, threads, runtime, performance]
13+
related:
14+
- /influxdb3/core/admin/performance-tuning/
15+
- /influxdb3/core/reference/config-options/
16+
- /influxdb3/core/admin/monitor-metrics/
17+
source: /shared/influxdb3-internals-reference/runtime-architecture.md
18+
---
19+
20+
<!--
21+
The content of this file is located at
22+
//SOURCE - content/shared/influxdb3-internals-reference/runtime-architecture.md
23+
-->
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Metrics
3+
seotitle: InfluxDB 3 Core metrics reference
4+
description: >
5+
InfluxDB 3 Core exposes Prometheus-format metrics,
6+
including descriptions, types, and labels for monitoring and observability.
7+
menu:
8+
influxdb3_core:
9+
parent: Reference
10+
weight: 106
11+
influxdb3/core/tags: [metrics, prometheus, monitoring, reference, observability]
12+
source: /shared/influxdb3-reference/metrics.md
13+
---
14+
15+
<!--
16+
The content of this file is located at
17+
//SOURCE - content/shared/influxdb3-reference/metrics.md
18+
-->

0 commit comments

Comments
 (0)