Documentation

InfluxDB 3 Enterprise

influxdb3 serve

The influxdb3 serve command starts the InfluxDB 3 Enterprise server.

Usage

influxdb3 serve [OPTIONS] \
  --node-id <NODE_IDENTIFIER_PREFIX> \
  --cluster-id <CLUSTER_IDENTIFIER_PREFIX>
  • Copy
  • Fill window

Required parameters

  • node-id: A unique identifier for your server instance. Must be unique for any hosts sharing the same object store.
  • cluster-id: A unique identifier for your cluster. Must be different from any node-id in your cluster.
  • object-store: Determines where time series data is stored. Default is memory.
  • data-dir: Path for local file storage (required when using --object-store file).

--node-id and --cluster-id support alphanumeric strings with optional hyphens.

Options

OptionDescription
--aws-access-key-idSee configuration options
--aws-allow-httpSee configuration options
--aws-default-regionSee configuration options
--aws-endpointSee configuration options
--aws-secret-access-keySee configuration options
--aws-session-tokenSee configuration options
--aws-skip-signatureSee configuration options
--azure-storage-access-keySee configuration options
--azure-storage-accountSee configuration options
--bucketSee configuration options
*--cluster-idSee configuration options
--compaction-gen2-durationSee configuration options
--compaction-max-num-files-per-planSee configuration options
--compaction-multipliersSee configuration options
--compaction-row-limitSee configuration options
--data-dirSee configuration options
--datafusion-configSee configuration options
--datafusion-max-parquet-fanoutSee configuration options
--datafusion-num-threadsSee configuration options
--datafusion-runtime-disable-lifo-slotSee configuration options
--datafusion-runtime-event-intervalSee configuration options
--datafusion-runtime-global-queue-intervalSee configuration options
--datafusion-runtime-max-blocking-threadsSee configuration options
--datafusion-runtime-max-io-events-per-tickSee configuration options
--datafusion-runtime-thread-keep-aliveSee configuration options
--datafusion-runtime-thread-prioritySee configuration options
--datafusion-runtime-typeSee configuration options
--datafusion-use-cached-parquet-loaderSee configuration options
--disable-parquet-mem-cacheSee configuration options
--distinct-cache-eviction-intervalSee configuration options
--exec-mem-pool-bytesSee configuration options
--force-snapshot-mem-thresholdSee configuration options
--gen1-durationSee configuration options
--google-service-accountSee configuration options
-h--helpPrint help information
--help-allPrint detailed help information
--http-bindSee configuration options
--last-cache-eviction-intervalSee configuration options
--license-emailSee configuration options
--license-fileSee configuration options
--log-destinationSee configuration options
--log-filterSee configuration options
--log-formatSee configuration options
--max-http-request-sizeSee configuration options
--modeSee configuration options
*--node-idSee configuration options
--object-storeSee configuration options
--object-store-cache-endpointSee configuration options
--object-store-connection-limitSee configuration options
--object-store-http2-max-frame-sizeSee configuration options
--object-store-http2-onlySee configuration options
--object-store-max-retriesSee configuration options
--object-store-retry-timeoutSee configuration options
--package-managerSee configuration options
--parquet-mem-cache-prune-intervalSee configuration options
--parquet-mem-cache-prune-percentageSee configuration options
--parquet-mem-cache-query-path-durationSee configuration options
--parquet-mem-cache-sizeSee configuration options
--plugin-dirSee configuration options
--preemptive-cache-ageSee configuration options
--query-file-limitSee configuration options
--query-log-sizeSee configuration options
--replication-intervalSee configuration options
--snapshotted-wal-files-to-keepSee configuration options
--traces-exporterSee configuration options
--traces-exporter-jaeger-agent-hostSee configuration options
--traces-exporter-jaeger-agent-portSee configuration options
--traces-exporter-jaeger-service-nameSee configuration options
--traces-exporter-jaeger-trace-context-header-nameSee configuration options
--traces-jaeger-debug-nameSee configuration options
--traces-jaeger-max-msgs-per-secondSee configuration options
--traces-jaeger-tagsSee configuration options
-v--verboseEnable verbose output
--virtual-env-locationSee configuration options
--wal-flush-intervalSee configuration options
--wal-max-write-buffer-sizeSee configuration options
--wal-snapshot-sizeSee configuration options
* Required options

Option environment variables

You can use environment variables to define most influxdb3 serve options. For more information, see Configuration options.

Examples

In the examples below, replace the following:

  • my-host-01: a unique string that identifies your InfluxDB 3 Enterprise server.
  • my-cluster-01: a unique string that identifies your InfluxDB 3 Enterprise cluster. The value you use must be different from --node-id values in the cluster.

Run the InfluxDB 3 server

influxdb3 serve \
  --object-store file \
  --data-dir ~/.influxdb3 \
  --node-id 
my-host-01
 \
  --cluster-id 
my-cluster-01
  • Copy
  • Fill window

Run a server in specific modes

influxdb3 serve \
  --object-store file \
  --data-dir ~/.influxdb3 \
  --node-id 
my-host-01
 \
  --cluster-id 
my-cluster-01
 \
  --mode ingest,query,process
  • Copy
  • Fill window

Run a server specifically for compacting data

influxdb3 serve \
  --object-store file \
  --data-dir ~/.influxdb3 \
  --node-id 
my-host-01
 \
  --cluster-id 
my-cluster-01
 \
  --mode compact
  • Copy
  • Fill window

Run the InfluxDB 3 server with extra verbose logging

influxdb3 serve \
  --verbose \
  --object-store file \
  --data-dir ~/.influxdb3 \
  --node-id 
my-host-01
 \
  --cluster-id 
my-cluster-01
  • Copy
  • Fill window

Run InfluxDB 3 with debug logging using LOG_FILTER

LOG_FILTER=debug influxdb3 serve \
  --object-store file \
  --data-dir ~/.influxdb3 \
  --node-id 
my-host-01
 \
  --cluster-id 
my-cluster-01
  • Copy
  • Fill window

Troubleshooting

Common Issues

  • Error: “cluster-id cannot match any node-id in the cluster”
    Ensure your --cluster-id value is different from all --node-id values in your cluster.

  • Error: “Failed to connect to object store”
    Verify your --object-store setting 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!

© 2025 InfluxData, Inc.

What is your InfluxDB 3 Enterprise URL?

Customize your InfluxDB 3 Enterprise URL and we’ll update code examples for you.

Default
Custom

For more information, see InfluxDB Cloud regions or InfluxDB OSS URLs.

Thank you for your feedback!

Let us know what we can do better:

Thank you!

No thanks

The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more

Now Generally Available

InfluxDB 3 Core and Enterprise

Start fast. Scale faster.

Get the Updates

InfluxDB 3 Core is an open source, high-speed, recent-data engine that collects and processes data in real-time and persists it to local disk or object storage. InfluxDB 3 Enterprise builds on Core’s foundation, adding high availability, read replicas, enhanced security, and data compaction for faster queries and optimized storage. A free tier of InfluxDB 3 Enterprise is available for non-commercial at-home or hobbyist use.

For more information, check out:

Ask AI