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.
The command is available in InfluxDB 3 Enterprise 3.10.0 and later.
Usage
influxdb3 debug object-store-check [OPTIONS]Options
| Option | Description | Required | |
|---|---|---|---|
--object-store <OBJECT_STORE> | Object store type. Valid values: s3, google, azure, file, memory | Yes | |
--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 URL | No | |
--aws-access-key-id <AWS_ACCESS_KEY_ID> | AWS access key ID | No | |
--aws-secret-access-key <AWS_SECRET_ACCESS_KEY> | AWS secret access key | No | |
--aws-allow-http | Allow non-HTTPS connections to the object store | No | |
--aws-default-region <AWS_DEFAULT_REGION> | AWS region | No | |
--check-prefix <CHECK_PREFIX> | Prefix for synthetic test objects. The command writes to <CHECK_PREFIX>/oscheck-<uuid>/. Environment variable: INFLUXDB3_OSCHECK_PREFIX | Yes | |
--probe-prefix <PROBE_PREFIX> | Prefix of an existing catalog to also replay the catalog loader’s startup operations against, to diagnose failures without writing new data. The probe itself is read-only, but the command still runs the synthetic write and delete checks under --check-prefix first. | No | |
-h | --help | Print help information | No |
--help-all | Print detailed help information | No |
Examples
Check a MinIO (S3-compatible) object store
Replace the following:
MINIO_USERNAME: your MinIO usernameMINIO_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 oscheckAlso probe an existing catalog prefix
Add --probe-prefix with your actual cluster ID to also diagnose catalog
load failures against your real catalog.
The probe itself is read-only, but the command still runs the synthetic
write and delete checks under --check-prefix first, so that prefix must
remain writable and the credentials need write access.
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-prefix my-cluster-idWas 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.