Documentation

influxdb3 serve

The influxdb3 serve command starts the InfluxDB 3 Core server.

Usage

influxdb3 serve [OPTIONS] --node-id <HOST_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.
  • 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 supports alphanumeric strings with optional hyphens.

Options

OptionDescription
*--node-idSee configuration options
--object-storeSee configuration options
--bucketSee configuration options
--data-dirSee configuration options
--aws-access-key-idSee configuration options
--aws-secret-access-keySee configuration options
--aws-default-regionSee configuration options
--aws-endpointSee configuration options
--aws-session-tokenSee configuration options
--aws-allow-httpSee configuration options
--aws-skip-signatureSee configuration options
--google-service-accountSee configuration options
--azure-storage-accountSee configuration options
--azure-storage-access-keySee configuration options
--object-store-connection-limitSee configuration options
--object-store-http2-onlySee configuration options
--object-store-http2-max-frame-sizeSee configuration options
--object-store-max-retriesSee configuration options
--object-store-retry-timeoutSee configuration options
--object-store-cache-endpointSee configuration options
-h--helpPrint help information
--help-allPrint detailed help information
--log-filterSee configuration options
-v--verboseEnable verbose output
--log-destinationSee configuration options
--log-formatSee 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-tagsSee configuration options
--traces-jaeger-max-msgs-per-secondSee configuration options
--datafusion-num-threadsSee configuration options
--datafusion-runtime-typeSee 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-max-parquet-fanoutSee configuration options
--datafusion-use-cached-parquet-loaderSee configuration options
--datafusion-configSee configuration options
--max-http-request-sizeSee configuration options
--http-bindSee configuration options
--exec-mem-pool-bytesSee configuration options
--gen1-durationSee configuration options
--wal-flush-intervalSee configuration options
--wal-snapshot-sizeSee configuration options
--wal-max-write-buffer-sizeSee configuration options
--snapshotted-wal-files-to-keepSee configuration options
--query-log-sizeSee configuration options
--parquet-mem-cache-sizeSee configuration options
--parquet-mem-cache-prune-percentageSee configuration options
--parquet-mem-cache-prune-intervalSee configuration options
--disable-parquet-mem-cacheSee configuration options
--last-cache-eviction-intervalSee configuration options
--distinct-cache-eviction-intervalSee configuration options
--plugin-dirSee configuration options
--force-snapshot-mem-thresholdSee configuration options
--virtual-env-locationSee configuration options
--package-managerSee configuration options
--query-file-limitSee 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 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-01
  • 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
  • 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
  • Copy
  • Fill window

Troubleshooting

Common Issues

  • 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!


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: