Skip to content

Milvus Vector Database

Collect Metrics related to Milvus Vector Database

Configuration

Prerequisites

  • DataKit installed
  • Install Milvus

Enable Milvus Monitoring

Navigate to the Milvus /home/$USER/milvus/conf directory and modify the server_config.yaml file to enable Milvus monitoring

metric:
  enable: true
  address: 127.0.0.1 
  port: 9091

Note: If Milvus is deployed in a Docker container, the above address should be modified to the host IP

  • After modification, restart Milvus and check the monitoring data via http://localhost:9091/metrics

Configure DataKit

  • Navigate to the conf.d/prom directory in the DataKit installation directory, copy prom.conf.sample and rename it to milvus.conf
cp prom.conf.sample milvus.conf
  • Adjust the content of milvus.conf as follows:
## Exporter URLs.
  urls = ["http://127.0.0.1:9091/metrics"]

  ## Stream Size. 
  ## The source stream segmentation size, (defaults to 1).
  ## 0 source stream undivided. 
  stream_size = 1

  ## Unix Domain Socket URL. Using socket to request data when not empty.
  uds_path = ""

  ## Ignore URL request errors.
  ignore_req_err = false

  ## Collector alias.
  source = "milvus"

  ## Measurement prefix.
  ## Add prefix to measurement set name.
  measurement_prefix = ""
  measurement_name = "milvus"

  ## (Optional) Collect interval: (defaults to "30s").
  interval = "30s"

  # [inputs.prom.tags]
    # some_tag = "some_value"
    # more_tag = "some_other_value"

Other configurations can be adjusted as needed, adjustment parameter descriptions:

  • urls: Metrics address, fill in the metrics url exposed by the corresponding component
  • source: Collector alias, it is recommended to distinguish
  • keep_exist_metric_name: Keep the metric name
  • interval: Collection interval
  • inputs.prom.tags: Add additional tags

Restart DataKit by executing the following command

datakit service -R

Metrics

Milvus Measurement

Milvus metrics are located under the milvus measurement, here is an introduction to Milvus metrics

Metrics Description Unit
ann_iterator_init_latency_bucket ANN iterator initialization latency distribution bucket s
bitset_ratio_bucket bitset ratio distribution bucket s
build_latency_bucket Index build latency distribution bucket s
build_latency_count Index build latency count count
build_latency_sum Index build latency sum s
search_latency_bucket Search latency distribution bucket s
search_latency_count Search latency count count
search_latency_sum Search latency sum count
search_topk_bucket Search topk distribution bucket s
search_topk_count Search topk count count
search_topk_sum Search topk sum count
milvus_datanode_consume_msg_count Data node consumed message count count
milvus_datanode_flush_buffer_op_count Data node flush buffer operation count count
milvus_datanode_msg_rows_count Data node message row count count
milvus_querynode_consume_tt_lag_ms Query node consumption time lag microsecond
milvus_querynode_disk_used_size Query node disk used size bytes
milvus_querynode_entity_num Query node entity count count
milvus_querynode_entity_size Query node entity size bytes
milvus_querynode_search_group_nq_bucket Query node search group query count distribution bucket s
milvus_querynode_search_group_nq_count Query node search group query count count
milvus_querynode_search_group_nq_sum Query node search group query sum count
milvus_proxy_req_count Proxy request count count
milvus_proxy_req_latency_bucket Proxy request latency distribution bucket s
milvus_proxy_req_latency_count Proxy request latency count count
milvus_proxy_req_latency_sum Proxy request latency sum s
milvus_proxy_search_vectors_count Proxy search vectors count count
milvus_proxy_send_bytes_count Proxy sent bytes count bytes
milvus_rootcoord_collection_num Root coordinator collection count count
milvus_rootcoord_ddl_req_count Root coordinator DDL request count count
milvus_rootcoord_ddl_req_latency_bucket Root coordinator DDL request latency distribution bucket s
milvus_rootcoord_ddl_req_latency_count Root coordinator DDL request latency count count
milvus_rootcoord_ddl_req_latency_sum Root coordinator DDL request latency sum s
milvus_rootcoord_entity_num Root coordinator entity count count
milvus_rootcoord_partition_num Root coordinator partition count count
milvus_rootcoord_produce_tt_lag_ms Root coordinator production time lag microsecond
milvus_storage_kv_size_bucket Milvus storage key-value size distribution bucket bytes
milvus_storage_kv_size_count Milvus storage key-value size count count
milvus_storage_kv_size_sum Milvus storage key-value size sum bytes
milvus_storage_op_count Milvus storage operation count count
milvus_storage_request_latency_bucket Milvus storage request latency distribution bucket s
milvus_storage_request_latency_count Milvus storage request latency count count
milvus_storage_request_latency_sum Milvus storage request latency sum s
milvus_num_node Milvus node count count
milvus_runtime_info Milvus runtime information -
process_max_fds Process maximum file descriptors count
process_open_fds Process open file descriptors count
process_start_time_seconds Process start time s
process_virtual_memory_bytes Process virtual memory bytes bytes
process_virtual_memory_max_bytes Process virtual memory maximum bytes bytes