metrics.md

title	sidebar_position
Metrics	70

Quickwit exposes key metrics in the Prometheus format on the /metrics endpoint. You can use any front-end that supports Prometheus to examine the behavior of Quickwit visually.

Cache Metrics

Currently Quickwit exposes metrics for three caches: fastfields, shortlived, splitfooter. These metrics share the same structure.

Namespace	Metric Name	Description	Type
quickwit_cache_{cache_name}	in_cache_count	Count of {cache_name} in cache	gauge
quickwit_cache_{cache_name}	in_cache_num_bytes	Number of {cache_name} bytes in cache	gauge
quickwit_cache_{cache_name}	cache_hit_total	Number of {cache_name} cache hits	counter
quickwit_cache_{cache_name}	cache_hits_bytes	Number of {cache_name} cache hits in bytes	counter
quickwit_cache_{cache_name}	cache_miss_total	Number of {cache_name} cache hits	counter

CLI Metrics

Namespace	Metric Name	Description	Type
quickwit	allocated_num_bytes	Number of bytes allocated memory, as reported by jemalloc.	gauge

Common Metrics

Namespace	Metric Name	Description	Labels	Type
quickwit	write_bytes	Number of bytes written by a given component in [indexer, merger, deleter, split_downloader_{merge,delete}]	[index, component]	counter

Indexing Metrics

Namespace	Metric Name	Description	Labels	Type
quickwit_indexing	processed_docs_total	Number of processed docs by index, source and processed status in [valid, schema_error, parse_error, transform_error]	[index, source, docs_processed_status]	counter
quickwit_indexing	processed_bytes	Number of processed bytes by index, source and processed status in [valid, schema_error, parse_error, transform_error]	[index, source, docs_processed_status]	counter
quickwit_indexing	available_concurrent_upload_permits	Number of available concurrent upload permits by component in [merger, indexer]	[component]	gauge
quickwit_indexing	ongoing_merge_operations	Number of available concurrent upload permits by component in [merger, indexer].	[index, source]	gauge

Ingest Metrics

Namespace	Metric Name	Description	Type
quickwit_ingest	ingested_num_bytes	Total size of the docs ingested in bytes	counter
quickwit_ingest	ingested_num_docs	Number of docs received to be ingested	counter
quickwit_ingest	queue_count	Number of queues currently active	counter

Metastore Metrics

All metastore methods are monitored by the 3 metrics:

Namespace	Metric Name	Description	Labels	Type
quickwit_metastore	requests_total	Number of requests	[operation, index]	counter
quickwit_metastore	request_errors_total	Number of failed requests	[operation, index]	counter
quickwit_metastore	request_duration_seconds	Duration of requests	[operation, index, error]	histogram

Examples of operation names: create_index, index_metadata, delete_index, stage_splits, publish_splits, list_splits, add_source, ...

Rest API Metrics

Namespace	Metric Name	Description	Type
quickwit	http_requests_total	Total number of HTTP requests received	counter

Search Metrics

Namespace	Metric Name	Description	Type
quickwit_search	leaf_searches_splits_total	Number of leaf searches (count of splits) started	counter
quickwit_search	leaf_search_split_duration_secs	Number of seconds required to run a leaf search over a single split. The timer starts after the semaphore is obtained	histogram
quickwit_search	active_search_threads_count	Number of threads in use in the CPU thread pool	gauge

Storage Metrics

Namespace	Metric Name	Description	Type
quickwit_storage	object_storage_gets_total	Number of objects fetched	counter
quickwit_storage	object_storage_puts_total	Number of objects uploaded. May differ from object_storage_requests_parts due to multipart upload	counter
quickwit_storage	object_storage_puts_parts	Number of object parts uploaded	counter
quickwit_storage	object_storage_download_num_bytes	Amount of data downloaded from an object storage	counter