influxdb3 debug sweep list

The influxdb3 debug sweep list command names the orphaned file cleanup passes recorded for a cluster, oldest to newest. It reads the audit trail directly from object storage and doesn’t need a running InfluxDB 3 Enterprise server.

Usage

influxdb3 debug sweep list [OPTIONS] --cluster-id <CLUSTER_ID>

Options

OptionDescriptionRequired
--object-store <OBJECT_STORE>Object store type. Valid values: s3, google, azure, file, memory. Default: file. Environment variable: INFLUXDB3_OBJECT_STORENo
--bucket <BUCKET>Object store bucket name. Required for s3, google, and azure object store typesVaries
--cluster-id <CLUSTER_ID>Cluster whose cleanup audit trail to read. Environment variable: INFLUXDB3_CLUSTER_IDYes
--engine-path-prefix <ENGINE_PATH_PREFIX>Engine path prefix the cluster runs with, if any. Environment variable: INFLUXDB3_ENGINE_PATH_PREFIXNo
-h, --helpPrint help informationNo
--help-allPrint detailed help informationNo

influxdb3 debug sweep list 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

List recorded cleanup passes

Replace the following:

  • CLUSTER_ID: your cluster identifier
  • S3_BUCKET: your object store bucket name
influxdb3 debug sweep list \
  --object-store s3 \
  --bucket 
S3_BUCKET
\
--cluster-id
CLUSTER_ID

If no passes are recorded yet, the command prints no passes recorded to standard error and exits successfully.


Was this page helpful?

Thank you for your feedback!