influxdb3 serve
The influxdb3 serve command starts the InfluxDB 3 Core server.
Usage
influxdb3 serve [OPTIONS]Required Parameters
- node-id: A unique identifier for your server instance. Must be unique for any hosts sharing the same object store.
- object-store: Determines where time series data is stored.
- Other object store parameters depending on the selected
object-storetype.
--node-id supports alphanumeric strings with optional hyphens.
Global configuration options
Some configuration options (like --num-io-threads) are global and must be specified before the serve command:
influxdb3 --num-io-threads=8 serve --node-id=node0 --object-store=file --verboseSee Global configuration options for the complete list.
Options
| Option | Description | |
|---|---|---|
| * | --node-id | See configuration options |
| * | --object-store | See configuration options |
--admin-token-recovery-http-bind | See configuration options | |
--admin-token-recovery-tcp-listener-file-path | See configuration options | |
--admin-token-file | See configuration options | |
--aws-access-key-id | See configuration options | |
--aws-allow-http | See configuration options | |
--aws-credentials-file | See configuration options | |
--aws-default-region | See configuration options | |
--aws-endpoint | See configuration options | |
--aws-secret-access-key | See configuration options | |
--aws-session-token | See configuration options | |
--aws-skip-signature | See configuration options | |
--azure-allow-http | See configuration options | |
--azure-endpoint | See configuration options | |
--azure-storage-access-key | See configuration options | |
--azure-storage-account | See configuration options | |
--bucket | See configuration options | |
--data-dir | See configuration options | |
--datafusion-config | See configuration options | |
--datafusion-max-parquet-fanout | See configuration options | |
--datafusion-num-threads | See configuration options | |
--datafusion-runtime-disable-lifo-slot | Development-only Tokio runtime configuration | |
--datafusion-runtime-event-interval | Development-only Tokio runtime configuration | |
--datafusion-runtime-global-queue-interval | Development-only Tokio runtime configuration | |
--datafusion-runtime-max-blocking-threads | Development-only Tokio runtime configuration | |
--datafusion-runtime-max-io-events-per-tick | Development-only Tokio runtime configuration | |
--datafusion-runtime-thread-keep-alive | Development-only Tokio runtime configuration | |
--datafusion-runtime-thread-priority | Development-only Tokio runtime configuration | |
--datafusion-runtime-type | Development-only Tokio runtime configuration | |
--datafusion-use-cached-parquet-loader | See configuration options | |
--delete-grace-period | See configuration options | |
--disable-authz | See configuration options | |
--disable-parquet-mem-cache | See configuration options | |
--distinct-cache-eviction-interval | See configuration options | |
--exec-mem-pool-bytes | See configuration options | |
--force-snapshot-mem-threshold | See configuration options | |
--gen1-duration | See configuration options | |
--gen1-lookback-duration | See configuration options | |
--google-service-account | See configuration options | |
--hard-delete-default-duration | See configuration options | |
-h | --help | Print help information |
--help-all | Print detailed help information | |
--http-bind | See configuration options | |
--last-cache-eviction-interval | See configuration options | |
--log-destination | See configuration options | |
--log-filter | See configuration options | |
--log-format | See configuration options | |
--max-http-request-size | See configuration options | |
--object-store-cache-endpoint | See configuration options | |
--object-store-connection-limit | See configuration options | |
--object-store-http2-max-frame-size | See configuration options | |
--object-store-http2-only | See configuration options | |
--object-store-max-retries | See configuration options | |
--object-store-retry-timeout | See configuration options | |
--package-manager | See configuration options | |
--parquet-mem-cache-prune-interval | See configuration options | |
--parquet-mem-cache-prune-percentage | See configuration options | |
--parquet-mem-cache-query-path-duration | See configuration options | |
--parquet-mem-cache-size | See configuration options | |
--plugin-dir | See configuration options | |
--preemptive-cache-age | See configuration options | |
--query-file-limit | See configuration options | |
--query-log-size | See configuration options | |
--retention-check-interval | See configuration options | |
--snapshotted-wal-files-to-keep | See configuration options | |
--table-index-cache-concurrency-limit | See configuration options | |
--table-index-cache-max-entries | See configuration options | |
--tcp-listener-file-path | See configuration options | |
--telemetry-disable-upload | See configuration options | |
--telemetry-endpoint | See configuration options | |
--tls-cert | See configuration options | |
--tls-key | See configuration options | |
--tls-minimum-version | See configuration options | |
--traces-exporter | See configuration options | |
--traces-exporter-jaeger-agent-host | See configuration options | |
--traces-exporter-jaeger-agent-port | See configuration options | |
--traces-exporter-jaeger-service-name | See configuration options | |
--traces-exporter-jaeger-trace-context-header-name | See configuration options | |
--traces-jaeger-debug-name | See configuration options | |
--traces-jaeger-max-msgs-per-second | See configuration options | |
--traces-jaeger-tags | See configuration options | |
--virtual-env-location | See configuration options | |
--wal-flush-interval | See configuration options | |
--wal-max-write-buffer-size | See configuration options | |
--wal-replay-concurrency-limit | See configuration options | |
--wal-replay-fail-on-error | See configuration options | |
--wal-snapshot-size | See configuration options | |
--without-auth | See configuration options |
Option environment variables
You can use environment variables to define most influxdb3 serve options.
For more information, see
Configuration options.
Quick-Start Mode
For development, testing, and home use, you can start InfluxDB 3 Core by running influxdb3 without the serve subcommand or any configuration parameters. The system automatically generates required values:
node-id:{hostname}-node(fallback:primary-node)object-store:filedata-dir:~/.influxdb
The system displays warning messages showing the auto-generated identifiers:
Using auto-generated node id: mylaptop-node. For production deployments, explicitly set --node-idQuick-start examples
# Zero-config startup
influxdb3
# Override specific defaults
influxdb3 --object-store memory
# Use environment variables to override defaults
INFLUXDB3_NODE_IDENTIFIER_PREFIX=my-node influxdb3Production deployments
Quick-start mode is designed for development and testing environments.
For production deployments, use explicit configuration with the serve subcommand
and specify all required parameters as shown in the Examples below.
Configuration precedence: CLI flags > environment variables > auto-generated defaults
For more information about quick-start mode, see Get started.
Examples
- Run the InfluxDB 3 server
- Run the InfluxDB 3 server with extra verbose logging
- Run InfluxDB 3 with debug logging using LOG_FILTER
In the examples below, replace
my-host-01:
with a unique string that identifies your InfluxDB 3 Core server.
Run the InfluxDB 3 server
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01Run the InfluxDB 3 server with extra verbose logging
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01
--verboseRun InfluxDB 3 with debug logging using LOG_FILTER
LOG_FILTER=debug influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01Troubleshooting
Common Issues
Error: “Failed to connect to object store”
Verify your--object-storesetting and ensure all required parameters for that storage type are provided.Permission errors when using S3, Google Cloud, or Azure storage
Check that your authentication credentials are correct and have sufficient permissions.
Was 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 Core and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.