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
Quickwit exposes metrics for several cache components, including fastfields, fd, partial_request, predicate, searcher_split, and 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_hits_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_misses_total
Number of {cache_name} cache hits
counter
quickwit_cache_{cache_name}
cache_evict_total
Number of {cache_name} cache entry evicted
counter
quickwit_cache_{cache_name}
cache_evict_bytes
Number of {cache_name} cache entry evicted in bytes
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
docs_bytes_total
Total size of the docs ingested, measured in ingester's leader, after validation and before persistence/replication
counter
quickwit_ingest
docs_total
Total number of the docs ingested, measured in ingester's leader, after validation and before persistence/replication
counter
quickwit_ingest
queue_count
Number of queues currently active
counter
Metastore Metrics
All metastore methods are monitored by the 3 metrics:
PostgreSQL-backed metastores also expose connection pool gauges:
Namespace
Metric Name
Description
Type
quickwit_metastore
active_connections
Number of active PostgreSQL pool connections, including used and idle connections
gauge
quickwit_metastore
idle_connections
Number of idle PostgreSQL pool connections
gauge
quickwit_metastore
acquire_connections
Number of requests currently waiting to acquire a PostgreSQL pool connection
gauge
quickwit_metastore
max_connections
Maximum number of PostgreSQL pool connections configured per metastore node
gauge
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
split_search_outcome
Number of local leaf split search outcomes by category (success, operational error, cache/pruning, or cancellation phase). Operational errors are classified by error (create_reader, warmup, tantivy_search, or panic). Retries are counted separately
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