Skip to main content
Version: 0.4.0

Metrics

Quickwit exposes some key metrics via Prometheus. 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.

NamespaceMetric NameDescriptionType
quickwit_cache_{cache_name}in_cache_countCount of {cache_name} in cachegauge
quickwit_cache_{cache_name}in_cache_num_bytesNumber of {cache_name} bytes in cachegauge
quickwit_cache_{cache_name}cache_hit_totalNumber of {cache_name} cache hitscounter
quickwit_cache_{cache_name}cache_hits_bytesNumber of {cache_name} cache hits in bytescounter
quickwit_cache_{cache_name}cache_miss_totalNumber of {cache_name} cache hitscounter

CLI Metrics

NamespaceMetric NameDescriptionType
quickwitallocated_num_bytesNumber of bytes allocated memory, as reported by jemalloc.gauge

Common Metrics

NamespaceMetric NameDescriptionLabelsType
quickwitwrite_bytesNumber of bytes written by a given component in [indexer, merger, deleter, split_downloader_{merge,delete}][index, component]counter

Indexing Metrics

NamespaceMetric NameDescriptionLabelsType
quickwit_indexingprocessed_docs_totalNumber of processed docs by index, source and processed status in [valid, missing_field, parsing_error, transform_error][index, source, docs_processed_status]counter
quickwit_indexingprocessed_docs_totalNumber of processed bytes by index, source and processed status in [valid, missing_field, parsing_error, transform_error][index, source, docs_processed_status]counter
quickwit_indexingavailable_concurrent_upload_permitsNumber of available concurrent upload permits by component in [merger, indexer][component]gauge
quickwit_indexingongoing_merge_operationsNumber of available concurrent upload permits by component in [merger, indexer].[index, source]gauge

Ingest Metrics

NamespaceMetric NameDescriptionType
quickwit_ingestingested_num_bytesTotal size of the docs ingested in bytescounter
quickwit_ingestingested_num_docsNumber of docs received to be ingestedcounter
quickwit_ingestqueue_countNumber of queues currently activecounter

Metastore Metrics

All metastore methods are monitored by the 3 metrics:

NamespaceMetric NameDescriptionLabelsType
quickwit_metastorerequests_totalNumber of requests[operation, index]counter
quickwit_metastorerequest_errors_totalNumber of failed requests[operation, index]counter
quickwit_metastorerequest_duration_secondsDuration 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

NamespaceMetric NameDescriptionType
quickwithttp_requests_totalTotal number of HTTP requests receivedcounter

Search Metrics

NamespaceMetric NameDescriptionType
quickwit_searchleaf_searches_splits_totalNumber of leaf searches (count of splits) startedcounter
quickwit_searchleaf_search_split_duration_secsNumber of seconds required to run a leaf search over a single split. The timer starts after the semaphore is obtainedhistogram
quickwit_searchactive_search_threads_countNumber of threads in use in the CPU thread poolgauge

Storage Metrics

NamespaceMetric NameDescriptionType
quickwit_storageobject_storage_gets_totalNumber of objects fetchedcounter
quickwit_storageobject_storage_puts_totalNumber of objects uploaded. May differ from object_storage_requests_parts due to multipart uploadcounter
quickwit_storageobject_storage_puts_partsNumber of object parts uploadedcounter
quickwit_storageobject_storage_download_num_bytesAmount of data downloaded from an object storagecounter