influxdb3 debug object-store-check

The influxdb3 debug object-store-check command validates that an object store correctly implements the semantic operations that InfluxDB 3 Enterprise relies on. It writes synthetic test objects to <CHECK_PREFIX>/oscheck-<uuid>/ and reports any compatibility violations. This command connects directly to the object store and does not require a running InfluxDB 3 Enterprise server.

Usage

influxdb3 debug object-store-check [OPTIONS]

Options

OptionDescriptionRequired
--object-store <OBJECT_STORE>Object store type. Valid values: s3, google, azure, file, memoryYes
--bucket <BUCKET>Object store bucket name. Required for s3, google, and azure object store types.Varies
--aws-endpoint <AWS_ENDPOINT>Custom AWS or S3-compatible endpoint URLNo
--aws-access-key-id <AWS_ACCESS_KEY_ID>AWS access key IDNo
--aws-secret-access-key <AWS_SECRET_ACCESS_KEY>AWS secret access keyNo
--aws-allow-httpAllow non-HTTPS connections to the object storeNo
--aws-default-region <AWS_DEFAULT_REGION>AWS regionNo
--check-prefix <CHECK_PREFIX>Prefix for synthetic test objects. The command writes to <CHECK_PREFIX>/oscheck-<uuid>/.No
--probe-prefix <PROBE_PREFIX>Read-only prefix to replay catalog loader operations against. Use this option to diagnose failures with an existing catalog without writing new data.No
-h--helpPrint help informationNo
--help-allPrint detailed help informationNo

Examples

Check a MinIO (S3-compatible) object store

Replace the following:

  • MINIO_USERNAME: your MinIO username
  • MINIO_PASSWORD: your MinIO password
influxdb3 debug object-store-check \
  --object-store s3 \
  --bucket influxdb3 \
  --aws-endpoint 
http://localhost:9000
\
--aws-access-key-id
MINIO_USERNAME
\
--aws-secret-access-key
MINIO_PASSWORD
\
--aws-allow-http \ --check-prefix oscheck

Probe an existing catalog prefix (read-only)

Use --probe-prefix with your actual cluster ID to diagnose catalog load failures without writing any data to the object store.

influxdb3 debug object-store-check \
  --object-store s3 \
  --bucket influxdb3 \
  --aws-endpoint http://localhost:9000 \
  --aws-access-key-id 
MINIO_USERNAME
\
--aws-secret-access-key
MINIO_PASSWORD
\
--aws-allow-http \ --probe-prefix
my-cluster-id

Was this page helpful?

Thank you for your feedback!