Skip to content

Commit 1203602

Browse files
authored
docs(influxdb3): document log-filter values and targeted filtering (#6695)
* chore(link-checker): update configs for v1.3.0 severity classification Remove exclusions for sites that return 403/429 (bot protection) and 5xx (server errors) - these are now handled by severity classification: - 403/401/429 → info (shown but don't fail CI) - 5xx/timeout → warning (shown but don't fail CI) - 404/410/DNS → error (fail CI) Removed exclusions: - GitHub, Slack, Reddit, StackOverflow - Docker Hub, Grafana, Microsoft Learn - Claude.ai, Dremio, Scarf, InfluxData support Kept exclusions: - Localhost/local network URLs - Example/placeholder URLs - CI-specific workarounds (canonical URLs, file fragments) Added [severity] configuration section with default thresholds. * docs(influxdb3): document log-filter values and targeted filtering Add comprehensive documentation for the --log-filter configuration option: - Log levels table (error, warn, info, debug, trace) - Targeted filtering syntax for specific components - Common component names for Core and Enterprise - Debug logging section in write troubleshoot page closes influxdata/DAR#575 * Update content/shared/influxdb3-cli/config-options.md
1 parent 36f9222 commit 1203602

File tree

3 files changed

+113
-2
lines changed

3 files changed

+113
-2
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ tmp
4343
# User context files for AI assistant tools
4444
.context/*
4545
!.context/README.md
46+
.task.md
4647

4748
# External repos
4849
.ext/*

content/shared/influxdb3-cli/config-options.md

Lines changed: 86 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -832,7 +832,92 @@ Sets the endpoint of an S3-compatible, HTTP/2-enabled object store cache.
832832

833833
#### log-filter
834834

835-
Sets the filter directive for logs.
835+
Sets the filter directive for logs. Use this option to control the verbosity of
836+
server logs globally or for specific components.
837+
838+
##### Log levels
839+
840+
The following log levels are available (from least to most verbose):
841+
842+
| Level | Description |
843+
| :------ | :---------------------------------------------------------------------------------------------------- |
844+
| `error` | Only errors |
845+
| `warn` | Warnings and errors |
846+
| `info` | Informational messages, warnings, and errors _(default)_ |
847+
| `debug` | Debug information for troubleshooting, plus all above levels |
848+
| `trace` | Very detailed tracing information, plus all above levels (produces high log volume) |
849+
850+
##### Basic usage
851+
852+
To set the log level globally, pass one of the log levels:
853+
854+
<!--pytest.mark.skip-->
855+
856+
```sh
857+
influxdb3 serve --log-filter debug
858+
```
859+
860+
##### Targeted filtering
861+
862+
Globally enabling `debug` or `trace` produces a high volume of log output.
863+
For more targeted debugging, you can set different log levels for specific
864+
components using the format `<global_level>,<component>=<level>`.
865+
866+
###### Debug write buffer operations
867+
868+
<!--pytest.mark.skip-->
869+
870+
```sh
871+
influxdb3 serve --log-filter info,influxdb3_write_buffer=debug
872+
```
873+
874+
###### Trace WAL operations
875+
876+
<!--pytest.mark.skip-->
877+
878+
```sh
879+
influxdb3 serve --log-filter info,influxdb3_wal=trace
880+
```
881+
882+
###### Multiple targeted filters
883+
884+
<!--pytest.mark.skip-->
885+
886+
```sh
887+
influxdb3 serve --log-filter info,influxdb3_write_buffer=debug,influxdb3_wal=debug
888+
```
889+
890+
{{% show-in "enterprise" %}}
891+
892+
###### Debug Enterprise storage engine operations
893+
894+
<!--pytest.mark.skip-->
895+
896+
```sh
897+
influxdb3 serve --log-filter info,influxdb3_pacha_tree=debug
898+
```
899+
900+
{{% /show-in %}}
901+
902+
##### Common component names
903+
904+
The following are common component names you can use for targeted filtering:
905+
906+
| Component | Description |
907+
| :------------------------------------ | :------------------------------------------------------- |
908+
| `influxdb3_write_buffer` | Write buffer operations |
909+
| `influxdb3_wal` | Write-ahead log operations |
910+
| `influxdb3_catalog` | Catalog and schema operations |
911+
| `influxdb3_cache` | Caching operations |
912+
{{% show-in "enterprise" %}}`influxdb3_pacha_tree` | Enterprise storage engine operations |
913+
`influxdb3_enterprise` | Enterprise-specific features |
914+
{{% /show-in %}}
915+
916+
> [!Note]
917+
> Targeted filtering requires knowledge of the codebase component names.
918+
> The component names correspond to Rust package names in the InfluxDB 3 source
919+
> code. Use `debug` or `trace` sparingly on specific components to avoid
920+
> excessive log output.
836921
837922
| influxdb3 serve option | Environment variable |
838923
| :--------------------- | :------------------- |

content/shared/influxdb3-write-guides/troubleshoot.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ Learn how to avoid unexpected results and recover from errors when writing to
66
- [Review HTTP status codes](#review-http-status-codes)
77
- [Troubleshoot failures](#troubleshoot-failures)
88
- [Troubleshoot rejected points](#troubleshoot-rejected-points)
9-
{{% show-in "core,enterprise" %}}- [Troubleshoot write performance issues](#troubleshoot-write-performance-issues){{% /show-in %}}
9+
{{% show-in "core,enterprise" %}}- [Troubleshoot write performance issues](#troubleshoot-write-performance-issues)
10+
- [Use debug logs for troubleshooting](#use-debug-logs-for-troubleshooting){{% /show-in %}}
1011

1112
## Handle write responses
1213

@@ -105,4 +106,28 @@ influxdb3 serve \
105106
Replace {{% code-placeholder-key %}}`PERCENTAGE`{{% /code-placeholder-key %}} with the percentage
106107
of available memory to allocate (for example, `35%` for write-heavy workloads).
107108

109+
### Use debug logs for troubleshooting
110+
111+
For deeper investigation of write issues, enable debug logging for specific
112+
components. Debug logs provide detailed information about write buffer
113+
operations and WAL activity.
114+
115+
To enable debug logs for write operations, restart {{% product-name %}} with
116+
targeted log filters:
117+
118+
<!--pytest.mark.skip-->
119+
120+
```sh
121+
influxdb3 serve --log-filter info,influxdb3_write_buffer=debug
122+
```
123+
124+
<!--pytest.mark.skip-->
125+
126+
```sh
127+
influxdb3 serve --log-filter info,influxdb3_wal=debug
128+
```
129+
130+
For more information about log levels and targeted filtering, see
131+
[log-filter configuration](/influxdb3/version/reference/config-options/#log-filter).
132+
108133
{{% /show-in %}}

0 commit comments

Comments
 (0)