Repository navigation
docs(influxdb): document InfluxDB OSS v2.10 options, metrics, and compaction throughput - #7867
Merged
Merged
Conversation
…paction throughput
…ith version What changed: Cross-link storage-compact-throughput and storage-compact-throughput-burst. Move the v2.10 availability note to the first paragraph of the per-user query and write bytes metric sections. Why: Review feedback. Readers can jump between related options, and see version availability before the description. Impact: Two v2 reference pages; no behavior change. Verification: Pre-commit hooks.
Contributor
Vale Style Check Results
Warnings (4)
✅ Check passed |
Contributor
Release version check
💡 Badge new features with the versionDocumenting a new feature? Add a version badge in the page frontmatter — the
For inline version text, use |
Contributor
🔗 Link Check Results — Link Check Bot✅ All links are valid
|
| Source File | URL | Issue |
|---|---|---|
content/enterprise_influxdb/v1/introduction/installation/single-server/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb/v1/introduction/install/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb/v1/introduction/install/_index.md |
https://reddit.com/r/influxdb | Error (cached) |
content/influxdb/v2/admin/security/enable-hardening/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb/v2/admin/security/enable-hardening/_index.md |
https://reddit.com/r/influxdb | Error (cached) |
content/influxdb/v2/install/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb/v2/install/_index.md |
https://docs.docker.com/engine/reference/run/#detached-vs-foreground | Cannot find fragment: Cannot find fragment |
content/influxdb/v2/reference/cli/influxd/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb/v2/reference/cli/influxd/upgrade/_index.md |
https://reddit.com/r/influxdb | Error (cached) |
content/influxdb/v2/reference/cli/influxd/upgrade/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb/v2/reference/config-options/_index.md |
https://reddit.com/r/influxdb | Error (cached) |
content/influxdb/v2/reference/config-options/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb/v2/reference/internals/metrics/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb/v2/reference/internals/metrics/_index.md |
https://reddit.com/r/influxdb | Error (cached) |
content/influxdb/v2/reference/internals/shards/_index.md |
https://reddit.com/r/influxdb | Error (cached) |
content/influxdb/v2/reference/internals/shards/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb/v2/reference/release-notes/influxdb/_index.md |
file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v2/api/buckets | File not found. Check if file exists and path is correct: File not found. Check … |
content/influxdb/v2/reference/release-notes/influxdb/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb/v2/reference/release-notes/influxdb/_index.md |
file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v2/api/tasks | File not found. Check if file exists and path is correct: File not found. Check … |
content/influxdb/v2/reference/release-notes/influxdb/_index.md |
file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v2/api/users | File not found. Check if file exists and path is correct: File not found. Check … |
Showing first 20 of 33 warnings. See the workflow run for full results.
Full details: workflow run summary and artifact. Last updated: 2026-10-15 20:25:44 UTC
…me-range errors What changed: - Add health-auth-mode and startup-error-linger to the config options reference, and explain how hardening-enabled restricts /health and /ready details. - Document that influxql-max-time-range errors return HTTP 200 with the error in results[].error, and that a query with no lower time bound exceeds any non-zero limit. - Add an exit codes section to the influxd reference, with a systemd RestartPreventExitStatus example. - Add a restricted health check details section to the enable-hardening page. - Link the new options and exit codes from the v2.10 release notes. - Add the six v2.10 flags to data/influxd_flags.yml. Why: influxdata/DAR#800 acceptance criteria. The behavior was verified against a local build of main-2.x (310ee146d9). Impact: InfluxDB OSS v2 reference, admin, and release notes pages only. Verification: Ran a live influxd for the max-time-range, startup failure, linger, and health-auth-mode cases. Confirmed the environment variable names with print-config. Code-block lint and link checks pass, and the pages render on a local Hugo server.
jstirnaman
marked this pull request as draft
October 9, 2026 15:42
Contributor
Author
|
The nonexistent |
jstirnaman
marked this pull request as ready for review
October 9, 2026 16:33
jstirnaman
added a commit
that referenced
this pull request
Oct 14, 2026
…release notes What changed: - metrics: link to the glossary `#rejected-points` anchor. - shards: point series and TSM links to the glossary, and fix the `influx bucket create` shard group duration anchor. - release notes: rename the "Errors updates" heading to "Error updates" so its table-of-contents link resolves, and fix the graph legend, dashboard cell refresh, and Flux v0.104.0, v0.99.0, and v0.95.0 anchors. Why: the link checker flagged 10 broken fragments on #7867. All 10 already existed on master. Verification: built the site with Hugo and confirmed each new anchor ID exists in the target page.
5 of 8 tasks
jstirnaman
added
release:pending
2 of 3 tasks
* sync(api): update InfluxDB OSS v2 and Cloud v2 specs for v2.10 What changed: - Resynced both specs from influxdata/openapi master. - Adds the v2.10 `/ready` and `/health` schemas from influxdata/openapi#661: measure groups (`progress`, `failures`), `uptime`, the `/ready` 503 response, and `version` and `commit` on `/health`. - Adds the Routes keys from influxdata/openapi#658. - Doesn't add `onConflict`. influxdata/openapi#663 removed it upstream. Why: the `docs-release/influxdb-oss` branch is still at v2.9.0, so this fetches OSS from master with `getswagger.sh v2 -b`. Supersedes #7699, #7841, and #7286. * chore(influxdb): bump InfluxDB OSS v2 latest to v2.10.0 Sets latest to v2.10 and latest_patches.v2 to 2.10.0 in data/products.yml. Leaves latest_cli.v2 at 2.8.0, because no new influx CLI release ships with v2.10. * feat(api): exclude schema properties that InfluxDB Cloud doesn't return What changed: - post-process-specs.ts applies a new content/exclude.yml overlay that removes listed schema properties from the published spec. Stale entries log a warning and don't fail the build. - The InfluxDB Cloud denylist removes the Routes keys that Cloud 2 doesn't return: backup, plugins, restore, scrapers, setup, sources, swagger, and system. - The Cloud Setup tag now explains that Cloud doesn't support initial setup: GET /api/v2/setup always returns {"allowed": false}. - Documented exclude.yml in the API docs README, and added test 16. Why: The upstream influxdata/openapi contract shares the Routes schema between OSS and Cloud, so the Cloud reference listed routes that Cloud doesn't serve. influxdata/openapi#658 adds more OSS-only keys. Internal clients might rely on the full contract, so docs-v2 filters at publish time instead of asking upstream to remove the keys. Impact: The published InfluxDB Cloud v2 API reference only. The committed spec stays a raw upstream mirror. Verification: GET /api/v2 on a production Cloud 2 org (2026-10-08) doesn't return the excluded keys. post-process-specs tests pass (57 of 57). Running the script on influxdb/cloud removes 3 properties from the current spec; the other 5 arrive with influxdata/openapi#658. * test(api): drop redundant exit-code assertion from exclude overlay test A failed run writes no build spec, so the readYaml call that follows already fails the test. * docs(influxdb): add v2.10.0 release notes Enhance the raw GitHub release draft into Google Developer Documentation style: action-oriented descriptions, docs links for options already documented in this release cycle, and no PR links or usernames. Filters internal-only changes (tests, WAL context cleanup, build flags, CI artifact storage) that don't affect users.
jstirnaman
added
release:ready
devanbenz
approved these changes
Oct 16, 2026
dhoard
pushed a commit
to dhoard/docs-v2
that referenced
this pull request
Oct 21, 2026
…paction throughput (influxdata#7867) * docs(influxdb): document InfluxDB OSS v2.10 options, metrics, and compaction throughput * docs(influxdb): link compaction throughput options and lead metrics with version What changed: Cross-link storage-compact-throughput and storage-compact-throughput-burst. Move the v2.10 availability note to the first paragraph of the per-user query and write bytes metric sections. Why: Review feedback. Readers can jump between related options, and see version availability before the description. Impact: Two v2 reference pages; no behavior change. Verification: Pre-commit hooks. * docs(influxdb): document v2.10 health options, exit codes, and max-time-range errors What changed: - Add health-auth-mode and startup-error-linger to the config options reference, and explain how hardening-enabled restricts /health and /ready details. - Document that influxql-max-time-range errors return HTTP 200 with the error in results[].error, and that a query with no lower time bound exceeds any non-zero limit. - Add an exit codes section to the influxd reference, with a systemd RestartPreventExitStatus example. - Add a restricted health check details section to the enable-hardening page. - Link the new options and exit codes from the v2.10 release notes. - Add the six v2.10 flags to data/influxd_flags.yml. Why: influxdata/DAR#800 acceptance criteria. The behavior was verified against a local build of main-2.x (310ee146d9). Impact: InfluxDB OSS v2 reference, admin, and release notes pages only. Verification: Ran a live influxd for the max-time-range, startup failure, linger, and health-auth-mode cases. Confirmed the environment variable names with print-config. Code-block lint and link checks pass, and the pages render on a local Hugo server. * docs(influxdb): add v2.10.0 release notes (influxdata#7911) * sync(api): update InfluxDB OSS v2 and Cloud v2 specs for v2.10 What changed: - Resynced both specs from influxdata/openapi master. - Adds the v2.10 `/ready` and `/health` schemas from influxdata/openapi#661: measure groups (`progress`, `failures`), `uptime`, the `/ready` 503 response, and `version` and `commit` on `/health`. - Adds the Routes keys from influxdata/openapi#658. - Doesn't add `onConflict`. influxdata/openapi#663 removed it upstream. Why: the `docs-release/influxdb-oss` branch is still at v2.9.0, so this fetches OSS from master with `getswagger.sh v2 -b`. Supersedes influxdata#7699, influxdata#7841, and influxdata#7286. * chore(influxdb): bump InfluxDB OSS v2 latest to v2.10.0 Sets latest to v2.10 and latest_patches.v2 to 2.10.0 in data/products.yml. Leaves latest_cli.v2 at 2.8.0, because no new influx CLI release ships with v2.10. * feat(api): exclude schema properties that InfluxDB Cloud doesn't return What changed: - post-process-specs.ts applies a new content/exclude.yml overlay that removes listed schema properties from the published spec. Stale entries log a warning and don't fail the build. - The InfluxDB Cloud denylist removes the Routes keys that Cloud 2 doesn't return: backup, plugins, restore, scrapers, setup, sources, swagger, and system. - The Cloud Setup tag now explains that Cloud doesn't support initial setup: GET /api/v2/setup always returns {"allowed": false}. - Documented exclude.yml in the API docs README, and added test 16. Why: The upstream influxdata/openapi contract shares the Routes schema between OSS and Cloud, so the Cloud reference listed routes that Cloud doesn't serve. influxdata/openapi#658 adds more OSS-only keys. Internal clients might rely on the full contract, so docs-v2 filters at publish time instead of asking upstream to remove the keys. Impact: The published InfluxDB Cloud v2 API reference only. The committed spec stays a raw upstream mirror. Verification: GET /api/v2 on a production Cloud 2 org (2026-10-08) doesn't return the excluded keys. post-process-specs tests pass (57 of 57). Running the script on influxdb/cloud removes 3 properties from the current spec; the other 5 arrive with influxdata/openapi#658. * test(api): drop redundant exit-code assertion from exclude overlay test A failed run writes no build spec, so the readYaml call that follows already fails the test. * docs(influxdb): add v2.10.0 release notes Enhance the raw GitHub release draft into Google Developer Documentation style: action-oriented descriptions, docs links for options already documented in this release cycle, and no PR links or usernames. Filters internal-only changes (tests, WAL context cleanup, build flags, CI artifact storage) that don't affect users.
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
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.
Closes influxdata/DAR#800
What changed
Configuration options (
reference/config-options.md)influxql-max-time-range. A statement that exceeds the limit returns HTTP200with the error inresults[].error. A query with no lower time bound exceeds any non-zero limit.http-user-query-bytes-enabledandhttp-user-write-bytes-enabled.health-auth-modeandstartup-error-linger. Thehealth-auth-modeentry explains that the default/healthand/readyresponses can expose file system paths after a failed startup.hardening-enabled: in v2.10, it also restricts/healthand/readydetails to callers with operator permissions.--storage-compact-throughputflag. Removed the statements that the flag is unavailable, that sustained and burst throughput are the same, and the example startup log entry whose keys differ in v2.10.storage-compact-throughput-burstandinternals/shards.mdto describe independent sustained and burst values. The two entries link to each other.Other pages
reference/cli/influxd/_index.md: Added an Exit codes section, with a systemdRestartPreventExitStatusexample.admin/security/enable-hardening.md: Added a Restricted health check details section.reference/internals/metrics.md: Added thehttp_query_user_response_bytesandhttp_write_user_request_bytescounters, and a note that the query metrics now include the legacy/queryendpoint.reference/cli/influxd/upgrade.md: Noted thatcoordinator.max-time-rangemaps toinfluxql-max-time-range.data/influxd_flags.yml: Added the six v2.10 flags to theinfluxdflags list.reference/release-notes/influxdb.md: Added a v2.10.0 section. The release date isTBD.Why
The influxdata/influxdb
main-2.xbranch contains these changes, and they ship in v2.10. The existing reference gives incorrect information about compaction throughput for v2.10.Impact
Readers of the v2 reference see v2.10 behavior. Don't merge until v2.10 is released. No v2.10 tag exists yet, and the newest tag is v2.9.1. Set the release notes date at merge.
Not included:
influxdbinds no flag for the newseries-id-set-cache-*settings, so users have nothing to configure./readyand/healthAPI reference: feat(v2): document /ready readiness gates in OpenAPI spec #7286 edits the OSS spec by hand, but influxdata/openapi has no matching source change, so the next sync would overwrite it. The v2.10 schema changes need to land in influxdata/openapi first.onConflictonPOST /api/v2/restore/bucketMetadata: feat: Update openapi contracts to include onConflict parameter for restore openapi#655 adds the parameter, but the server ignores it, and [2.x] Addon-conflictto influxdb restore influxdb#27578 was closed as not planned. Hold sync(api): update InfluxDB OSS v2 spec #7699 until engineering decides. See the comment on influxdata/DAR#800.Routesschema: sync(api): update InfluxDB Cloud v2 spec #7841 adds keys that Cloud doesn't advertise or serve. The public Cloud reference should list only live paths.Follow-ups: influxdata/DAR#801 (Cloud Serverless
influx setup) and influxdata/DAR#802 (v1 and v2 coordination for the ported options).For engineering: influxdata/influxdb#27695 nonexistent --health-auth-enabled flag
in HEALTH_READY.md
Verification
Tested against a local build of influxdata/influxdb
main-2.xat310ee146d9:influxd run --helplists all six v2.10 flags.influxd print-configconfirms theINFLUXD_HEALTH_AUTH_MODEandINFLUXD_STARTUP_ERROR_LINGERenvironment variables.influxql-max-time-range=1h: a 30-minute query returns data. 2-hour and unbounded queries return200withmax-time-range limit exceededinresults[].error./readyduring startup returns503withstatus: starting, failing-onlychecks, anduptime. After startup, it returns200withoutchecks.--health-auth-mode=required: the status code doesn't change for any caller. Only an operator token returns check messages,version, andcommit.--bolt-pathset to a directory):/healthand/readyreturn503during the linger window, and other paths return503 {"status":"starting"}.influxdexits with code66after the window, or after about 1 second with--startup-error-linger=0. Underrequired, every caller gets names and statuses only, because tokens can't be verified.Docs checks: code-block lint and link checks pass, and the changed pages render on a local Hugo server.
Checklist
npx hugo --quiet)