Repository navigation
docs(enterprise): correct the compaction-cleanup-wait default and tuning example - #7869
Merged
Merged
Conversation
What changed: the documented default of `--compaction-cleanup-wait` is now `1h` instead of `10m`. Why: InfluxDB 3 Enterprise changed the default from `10m` to `1h` in v3.4.2 (influxdata/influxdb_pro#1300), and every release since uses `1h`. The docs still showed the old value, so anyone who copies the documented default runs with a much shorter wait than the product uses. The wait is the time query nodes have to move to newly compacted files before the compactor deletes the files they replace. Impact: documentation only. Verification: checked the `default_value` of `--compaction-cleanup-wait` in influxdb_pro at v3.4.2, v3.5.0 to v3.12.0 and main (`1h`), and at v3.0.3 to v3.4.1 (`10m`).
praveen-influx
added
product:v3-monolith
Contributor
Vale Style Check Results
Warnings (1)
✅ Check passed |
Contributor
🔗 Link Check Results — Link Check Bot✅ All links are valid
|
| Source File | URL | Issue |
|---|---|---|
content/influxdb3/core/reference/config-options/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/admin/clustering/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/reference/config-options/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
Full details: workflow run summary and artifact. Last updated: 2026-10-09 10:31:15 UTC
…ning example What changed: the "Tune compaction parameters" example in the clustering guide no longer sets `--compaction-cleanup-wait=10m`. Why: the cleanup wait does not change how compaction runs or what it costs. It only sets how long the compactor keeps the files a compaction replaced before it deletes them. A shorter wait gives query nodes less time to move to the new files, so a query node that falls behind can fail queries with "file not found" errors. It does not belong in an example about balancing compaction performance and resource usage, and `10m` is a sixth of the `1h` default. Impact: documentation only. Verification: the example's last line no longer ends with a line continuation.
praveen-influx
changed the title
praveen-influx
commented
Oct 9, 2026
| --compaction-multipliers=4,8,16 \ | ||
| --compaction-max-num-files-per-plan=100 \ | ||
| --compaction-cleanup-wait=10m | ||
| --compaction-max-num-files-per-plan=100 |
Contributor
Author
There was a problem hiding this comment.
I'm not sure if the --compaction-cleanup-wait=10m is necessary here given 10m is the default prior to this PR. So, I just removed it as I think reducing this to 10m has side effects on query node as mentioned in the PR description.
praveen-influx
marked this pull request as ready for review
October 9, 2026 10:33
praveen-influx
requested review from
jstirnaman
and removed request for
a team
October 9, 2026 10:33
jstirnaman
approved these changes
Oct 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The configuration reference says the default for
--compaction-cleanup-waitis10m. InfluxDB 3 Enterprise has used1hsince v3.4.2. This PR changes the documented default to1h. It also removes--compaction-cleanup-wait=10mfrom the clustering guide's compaction tuning example, because the cleanup wait does not tune compaction.What changed
compaction-cleanup-wait: Default is now1hinstead of10m.--compaction-cleanup-wait=10m. The cleanup wait does not change how compaction runs or what it costs; it only sets how long replaced files are kept. Showing it in a tuning example, at a sixth of the default, makes the failure described below more likely.Why
The default changed from
10mto1hin v3.4.2 (influxdata/influxdb_pro#1300). The docs kept the old value.This wait is used by compactor on how long it waits before the compactor can clear the older (older than this wait time) compacted files. If a query node falls behind the configured wait time, its queries can fail with "file not found" errors as the querier could have loaded an older compactor's metadata file pointing to references of data/index files that have been deleted already by compactor.
Impact
Documentation only. Readers who copy the documented default will now get the value the product actually uses.
Verification
default_valueof--compaction-cleanup-waitin the influxdb_pro source at every release line (table below).npx hugo --quietlocally. Relying on CI.Default by release
10m1hThe same change moved
--catalog-sync-intervalfrom10sto1s. The docs already show1sfor that option, so this PR does not touch it.Preview pages
/influxdb3/enterprise/reference/config-options/#compaction-cleanup-wait
Expected: Default:
1h/influxdb3/enterprise/admin/clustering/#tune-compaction-parameters
Expected: the example sets
--compaction-multipliersand--compaction-max-num-files-per-planonlyChecklist
npx hugo --quiet)