Skip to main content

Quickwit configuration

This page documents the Quickwit configuration properties. It is divided into three parts:

  • Common properties.
  • Indexer properties: defined in [indexer] section of the configuration file.
  • Searcher properties: defined in [searcher] section of the configuration file.

A commented example is accessible here: quickwit.yaml.

Common configuration

PropertyDescriptionDefault value
versionConfig file version. 0 is the only available value.
node_idNode ID of the instance (searcher or indexer). It must be unique in your cluster. If not set, a random ID is generated at each boot.
listen_addressThe IP address or hostname that Quickwit service binds to for starting REST and GRPC server and connecting this node to other nodes. By default, Quickwit binds itself to 127.0.0.1 (localhost). This default is not valid when trying to form a cluster.127.0.0.1
rest_listen_portThe port which to listen for HTTP REST API.7280
peer_seedsList of IP addresses used by gossip for bootstrapping new nodes joining a cluster. This list may contain the current node address, and it does not need to be exhaustive on every node.
data_dir_pathPath to directory where data (tmp data, splits kept for caching purpose) is persisted. This is mostly used in indexing../qwdata
metastore_uriMetastore URI. Can be a local directory or s3://my-bucket/indexes or postgres://username:password@localhost:5432/metastore. Learn more about the metastore configuration.{data_dir}/indexes
default_index_root_uriDefault index root URI that defines the location where index data (splits) is stored. The index uri is build following the the scheme: {default_index_root_uri}/{index-id}{data_dir}/indexes

Indexer configuration

This section contains the configuration options for an indexer. The split store is documented in the indexing document.

PropertyDescriptionDefault value
split_store_max_num_bytesMaximum size in bytes allowed in the split store for each index-source pair.200G
split_store_max_num_splitsMaximum number of files allowed in the split store for each index-source pair.10000

Searcher configuration

This section contains the configuration options for a Searcher.

PropertyDescriptionDefault value
fast_field_cache_capacityFast field cache capacity on a Searcher.10G
split_footer_cache_capacitySplit footer cache (it is essentially the hotcache) capacity on a Searcher.1G
max_num_concurrent_split_streamsMaximum number of concurrent split stream requests running on a Searcher.100