docs(influxdb3): document Enterprise load capture - #7476
Merged
Conversation
What changed: - Added Enterprise load capture admin and CLI reference pages with v3.10.0 metadata. - Added storage-engine prerequisite notes and synchronized public OpenAPI specifications. Why: - Operators need accurate guidance for the new v3.10.0 Enterprise load capture API and CLI commands. Impact: - The Enterprise documentation and API reference expose load capture while Core continues to omit the Enterprise-only endpoints. Verification: - npx hugo --quiet --environment development --destination /tmp/docs-v2-loadcap-note-verify --cleanDestinationDir --noBuildLock - yarn lint-codeblocks content/influxdb3/enterprise/admin/load-capture.md content/influxdb3/enterprise/reference/cli/influxdb3/loadcap/*.md - docs-tooling OpenAPI generation, tests, and downstream drift check
Contributor
Vale Style Check Results
Warnings (7)
✅ Check passed |
Contributor
🔗 Link Check Results — Link Check Bot✅ All links are valid
|
| Source File | URL | Issue |
|---|---|---|
content/influxdb3/enterprise/admin/load-capture/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/reference/cli/influxdb3/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/reference/cli/influxdb3/loadcap/delete/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/reference/cli/influxdb3/loadcap/download/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/reference/cli/influxdb3/loadcap/files/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/reference/cli/influxdb3/loadcap/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/reference/cli/influxdb3/loadcap/list/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/reference/cli/influxdb3/loadcap/preview/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/reference/cli/influxdb3/loadcap/start/_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-07-21 15:05:54 UTC
jstirnaman
marked this pull request as ready for review
July 13, 2026 22:13
jstirnaman
requested review from
peterbarnett03,
philjb and
sanderson
and removed request for
a team
July 13, 2026 22:13
Contributor
|
github-actions
Bot
added
the
product:v3-monolith
This was referenced Jul 20, 2026
…enAPI specs What changed: - Restored the plugin_filename description removed in an earlier commit: the "Fetch a plugin remotely" section covering the gh: prefix, --plugin-repo, INFLUXDB3_PLUGIN_REPO, fetch behavior, and error output. - Corrected the flag name from --plugins-dir to --plugin-dir. - Aligned gh: wording with plugin docs: gh: fetches remotely and doesn't require GitHub; --plugin-repo accepts any HTTP/HTTPS raw file URL. Why: - The spec sync in this branch reverted plugin documentation that had been revised on master, and the OpenAPI wording predated the gh: clarification in the plugin guides.
What changed: - Replaced the gh: details in the plugin_filename description with a short summary and a link to the Use example plugins section of the plugins guide. - Kept the corrections from the previous commit: --plugin-dir flag name and remote-fetch wording (gh: doesn't require GitHub). Why: - The plugins guide is the source of truth for gh: defaults, fetch behavior, and limitations; duplicating them in the spec invites drift.
jstirnaman
enabled auto-merge
July 21, 2026 15:07
jstirnaman
disabled auto-merge
July 21, 2026 15:14
jstirnaman
added a commit
that referenced
this pull request
Aug 4, 2026
…`loadcap`)
What changed
Adds a user-facing guide for InfluxDB 3 Enterprise **load capture**
(`loadcap`) at `admin/load-capture` ("Capture workload data"). The guide
covers:
- Availability and the `--mode query` prerequisite.
- `query` and `write`/`both` capture types and constraints.
- Starting, listing, previewing, downloading, extracting, and deleting a
capture (CLI and links to the API reference).
- Inspecting a capture before sharing and what load capture anonymizes
vs. preserves.
Also adds `(?i)anonymiz\w*` to the Vale accept vocabulary.
Why
Issue #7466 and PR #7476 deliver the load capture API reference, but the
feature had no guide explaining what it is, when to use it, who runs it,
and how to inspect a capture before sharing it with InfluxData. Self-hosted
operators and InfluxData support use load capture to troubleshoot write and
query performance by reproducing an anonymized workload.
## Impact
- Enterprise-only content. The page lives in Enterprise content, not in
`/shared/`, because load capture does not exist on Core.
- New menu item under **Administer InfluxDB** → "Capture workload data".
- The guide links to the load capture API reference page, which lands with
#7476. That link resolves once #7476 merges; expect it to dangle in link
checks until then.
Verification
All documented behavior was verified against the shipped **InfluxDB 3
Enterprise 3.10.2** binary.
- **Availability:** `loadcap` initializes only on a `--mode query` node.
`--mode all` returns `404 loadcap not available`; Core rejects the
`loadcap` subcommand. (The engineering draft's "combined node that
includes query mode" was incorrect and is corrected here.)
- **Query capture:** `start → preview → download → extract` verified; 778
queries captured and anonymized.
- **Write/both capture:** verified on an ingest+query MinIO cluster; a
`both` capture produced 18 `.pt` files, `catalog.json`, and
`queries.json.zst`.
- **Anonymization:** a plaintext leak grep for database, table, tag,
tag-value, and string-field names across all `.pt` files and
`catalog.json` returned **0 hits**. SQL and InfluxQL identifiers and
literals are hashed, regex structure is preserved, timestamps and time
predicates are preserved, per-capture keys differ, and
`INSERT`/`UPDATE`/`DELETE` become `<unsupported:...>`.
- **Constraints:** one capture at a time (`409`), maximum duration 1h
(`400` above), and `catalog.json` is a start-of-capture snapshot.
- **Docs checks:** `npx hugo` builds and the page renders; 14 code blocks
pass `lint-codeblocks`; Vale reports 0 errors/0 warnings.
Follow-ups
- #7534: document the token permission `loadcap` requires (admin vs
scoped) — verification used an admin token.
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
1 participant
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.
What changed
Added InfluxDB 3 Enterprise load capture admin and CLI reference pages, v3.10.0 version metadata, storage-engine prerequisite notes, and synchronized public OpenAPI specifications.
Why
Operators need accurate guidance for the load capture endpoints and CLI commands introduced in v3.10.0. Closes #7466
Impact
Enterprise documentation and API reference now expose load capture and its availability requirements; Core remains free of Enterprise-only endpoints.
Verification
npx hugo --quiet --environment development --destination /tmp/docs-v2-loadcap-note-verify --cleanDestinationDir --noBuildLockyarn lint-codeblocks content/influxdb3/enterprise/admin/load-capture.md content/influxdb3/enterprise/reference/cli/influxdb3/loadcap/*.md