docs(influxdb3): add Enterprise load capture guide - #7539
Merged
Conversation
Add a user-facing guide for InfluxDB 3 Enterprise load capture (loadcap) at admin/load-capture, covering query and write/both capture, inspection, and anonymization. Companion to the load capture API reference (#7476, issue #7466). All behavior documented here 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 entirely. (The engineering draft's "combined node that includes query mode" was wrong.) - 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: leak grep for db/table/tag/value/string-field names across all .pt files and catalog.json returned 0 hits. SQL and InfluxQL identifiers/literals hashed, regex structure preserved, timestamps/time predicates preserved, per-capture keys differ, INSERT/UPDATE/DELETE -> <unsupported:...>. - Constraints: one capture at a time (409), max duration 1h (400 above), catalog.json is a start-of-capture snapshot. Add "(?i)anonymiz\w*" to the Vale accept vocabulary. Note: the guide links to the load capture API reference page, which lands with #7476.
Contributor
Vale Style Check Results
✅ Check passed |
github-actions
Bot
added
the
product:v3-monolith
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/admin/load-capture/_index.md |
file:///home/runner/work/docs-v2/docs-v2/public/influxdb3/enterprise/api/load-capture | File not found. Check if file exists and path is correct: File not found. Check … |
Full details: workflow run summary and artifact. Last updated: 2026-08-04 19:35:14 UTC
Contributor
|
jstirnaman
changed the base branch from
master
to
fix/7464-show-in-table-splicing
July 21, 2026 14:33
jstirnaman
changed the base branch from
fix/7464-show-in-table-splicing
to
master
July 21, 2026 14:36
…ndow Restructure 'Capture a workload profile' into ordered steps: start the capture, send traffic while it runs, wait for completion, then preview. State that only traffic received during the capture window is recorded and that previously executed queries do not appear in the profile.
…e-load-capture # Conflicts: # content/influxdb3/enterprise/admin/load-capture.md
Add the four missing loadcap operations, verified against a running
InfluxDB 3 Enterprise 3.10.3 cluster:
- GET /api/v3/loadcap/profiles/{profile_id} (returns the preview object)
- DELETE /api/v3/loadcap/profiles/{profile_id}
- GET /api/v3/loadcap/profiles/{profile_id}/preview
- GET /api/v3/loadcap/profiles/{profile_id}/download (application/gzip)
Fix the LoadCaptureProfile schema to match observed responses: the
capture-type field is named 'type', and node_id is an integer. Add the
LoadCapturePreview schema and the profile_id path parameter.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an Enterprise workload-capture guide and completes its API reference.
Changes:
- Documents capture, inspection, anonymization, and sharing workflows.
- Adds profile management API operations and schemas.
- Extends Vale vocabulary for anonymization terms.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
content/influxdb3/enterprise/admin/load-capture.md |
Adds the user guide. |
api-docs/influxdb3/enterprise/influxdb3-enterprise-openapi.yaml |
Completes load-capture API coverage. |
.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt |
Accepts anonymization terms. |
Comments suppressed due to low confidence (6)
content/influxdb3/enterprise/admin/load-capture.md:83
- The PR verification and linked issue #7534 say only an admin token was tested and the minimum required permission is still unknown. This definitive prerequisite is therefore unsupported; describe the token used by the examples until the authorization requirement is verified.
- Load capture requires an
[admin token](/influxdb3/enterprise/admin/tokens/admin/).
api-docs/influxdb3/enterprise/influxdb3-enterprise-openapi.yaml:2526
- The PR verification and #7534 state that only an admin token was tested; whether it is required remains unknown. This delete operation therefore documents an unverified authorization contract, including the corresponding 403 response. Remove or qualify the requirement until permission testing confirms it.
This endpoint requires an admin token.
api-docs/influxdb3/enterprise/influxdb3-enterprise-openapi.yaml:2554
- The PR verification and #7534 state that only an admin token was tested; whether it is required remains unknown. This preview operation therefore documents an unverified authorization contract, including the corresponding 403 response. Remove or qualify the requirement until permission testing confirms it.
This endpoint requires an admin token.
api-docs/influxdb3/enterprise/influxdb3-enterprise-openapi.yaml:2587
- The PR verification and #7534 state that only an admin token was tested; whether it is required remains unknown. This download operation therefore documents an unverified authorization contract, including the corresponding 403 response. Remove or qualify the requirement until permission testing confirms it.
This endpoint requires an admin token.
content/influxdb3/enterprise/admin/load-capture.md:222
- A write-only archive omits
queries.json.zst, so this command fails for that supported capture type. Scope the instruction to captures that contain query artifacts.
Inspect the anonymized queries:
content/influxdb3/enterprise/admin/load-capture.md:240
- Query-only archives omit
.ptfiles, so thislscommand fails for that supported capture type. Scope this inspection step to captures that contain WAL artifacts.
The `.pt` files are binary WAL files for InfluxData tooling.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
What changed
Adds a user-facing guide for InfluxDB 3 Enterprise load capture
(
loadcap) atadmin/load-capture("Capture workload data"). The guidecovers:
--mode queryprerequisite.queryandwrite/bothcapture types and constraints.capture (CLI and links to the API reference).
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
/shared/, because load capture does not exist on Core.docs(influxdb3): document Enterprise load capture #7476. That link resolves once docs(influxdb3): document Enterprise load capture #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.
loadcapinitializes only on a--mode querynode.--mode allreturns404 loadcap not available; Core rejects theloadcapsubcommand. (The engineering draft's "combined node thatincludes query mode" was incorrect and is corrected here.)
start → preview → download → extractverified; 778queries captured and anonymized.
bothcapture produced 18.ptfiles,catalog.json, andqueries.json.zst.tag-value, and string-field names across all
.ptfiles andcatalog.jsonreturned 0 hits. SQL and InfluxQL identifiers andliterals are hashed, regex structure is preserved, timestamps and time
predicates are preserved, per-capture keys differ, and
INSERT/UPDATE/DELETEbecome<unsupported:...>.409), maximum duration 1h(
400above), andcatalog.jsonis a start-of-capture snapshot.npx hugobuilds and the page renders; 14 code blockspass
lint-codeblocks; Vale reports 0 errors/0 warnings.Follow-ups
loadcaprequires (admin vsscoped) — verification used an admin token.