Documentation

influxdb3 serve

InfluxDB 3 Core is in Public Alpha

InfluxDB 3 Core is in public alpha and available for testing and feedback, but is not meant for production use. Both the product and this documentation are works in progress. We welcome and encourage your input about your experience with the alpha and invite you to join our public channels for updates and to share feedback.

Alpha expectations and recommendations

The influxdb3 serve command starts the InfluxDB 3 Core server.

Usage

influxdb3 serve [OPTIONS] --node-id <HOST_IDENTIFIER_PREFIX>

Options

OptionDescription
--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
--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
--ram-pool-data-bytesSee configuration options
--exec-mem-pool-bytesSee configuration options
--bearer-tokenSee 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
--buffer-mem-limit-mbSee configuration options
*--node-idSee configuration options
--parquet-mem-cache-size-mbSee 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_ID: with a unique identifier for your InfluxDB 3 Core server.

Run the InfluxDB 3 server

influxdb3 serve \
  --object-store file \
  --data-dir ~/.influxdb3 \
  --node-id 
MY_HOST_ID

Run the InfluxDB 3 server with extra verbose logging

influxdb3 serve \
  --verbose \
  --object-store file \
  --data-dir ~/.influxdb3 \
  --node-id 
MY_HOST_ID

Run InfluxDB 3 with debug logging using LOG_FILTER

LOG_FILTER=debug influxdb3 serve \
  --object-store file \
  --data-dir ~/.influxdb3 \
  --node-id 
MY_HOST_ID

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

InfluxDB 3 Open Source Now in Public Alpha

InfluxDB 3 Open Source is now available for alpha testing, licensed under MIT or Apache 2 licensing.

We are releasing two products as part of the alpha.

InfluxDB 3 Core, is our new open source product. It is a recent-data engine for time series and event data. InfluxDB 3 Enterprise is a commercial version that builds on Core’s foundation, adding historical query capability, read replicas, high availability, scalability, and fine-grained security.

For more information on how to get started, check out: