influxdb3 debug sweep report
The influxdb3 debug sweep report command reads one
orphaned file cleanup
pass’s audit trail back and summarizes it.
It reads directly from object storage and doesn’t need a running
InfluxDB 3 Enterprise server.
Usage
influxdb3 debug sweep report [OPTIONS] --cluster-id <CLUSTER_ID>Options
| Option | Description | Required |
|---|---|---|
--object-store <OBJECT_STORE> | Object store type. Valid values: s3, google, azure, file, memory. Default: file. Environment variable: INFLUXDB3_OBJECT_STORE | No |
--bucket <BUCKET> | Object store bucket name. Required for s3, google, and azure object store types | Varies |
--cluster-id <CLUSTER_ID> | Cluster whose cleanup audit trail to read. Environment variable: INFLUXDB3_CLUSTER_ID | Yes |
--engine-path-prefix <ENGINE_PATH_PREFIX> | Engine path prefix the cluster runs with, if any. Environment variable: INFLUXDB3_ENGINE_PATH_PREFIX | No |
--pass <PASS> | Pass to summarize. Defaults to the newest pass that has at least one readable segment | No |
--candidates | Print every recorded candidate path, marked queued (a segment enqueued it for deletion) or would-be (found but not enqueued, for example, by a dry-run segment) | No |
--json | Emit the summary as JSON, including full segment detail | No |
-h, --help | Print help information | No |
--help-all | Print detailed help information | No |
influxdb3 debug sweep report accepts the same object store connection
options as influxdb3 serve. For example, --aws-access-key-id and
--aws-secret-access-key for S3-compatible stores.
For the complete object store flag reference, see
influxdb3 debug object-store-check.
Examples
Replace the following in the examples below:
CLUSTER_ID: your cluster identifierS3_BUCKET: your object store bucket namePASS_NAME: a pass name returned byinfluxdb3 debug sweep list
Summarize the newest pass
influxdb3 debug sweep report \
--object-store s3 \
--bucket S3_BUCKET \
--cluster-id CLUSTER_IDThe summary includes whether the pass is complete, how many segments it wrote, how many objects it scanned, the candidate count and reclaimable bytes, and a breakdown of protected objects by reason.
Summarize a specific pass
influxdb3 debug sweep report \
--object-store s3 \
--bucket S3_BUCKET \
--cluster-id CLUSTER_ID \
--pass PASS_NAME \
--candidatesCompare a dry-run pass against an armed pass
Use --json to get the full segment detail and diff two passes, for
example, to confirm a dry-run pass and a later armed pass found the
same candidates:
influxdb3 debug sweep report \
--object-store s3 \
--bucket S3_BUCKET \
--cluster-id CLUSTER_ID \
--pass PASS_NAME \
--json > pass-summary.jsonWas this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB 3 Enterprise and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support. Customers using a trial license can email trial@influxdata.com for assistance.