From ef3ee9276b2d5584d862709e0541904ee7f09032 Mon Sep 17 00:00:00 2001 From: David Kirov Date: Mon, 23 Dec 2024 13:32:34 +0200 Subject: [PATCH] Incorporate documentation suggestions --- milvus/metadata.csv | 92 ++++++++++++++++++++++----------------------- 1 file changed, 46 insertions(+), 46 deletions(-) diff --git a/milvus/metadata.csv b/milvus/metadata.csv index 58757fbc376f3..9725cfdb508e5 100644 --- a/milvus/metadata.csv +++ b/milvus/metadata.csv @@ -22,7 +22,7 @@ milvus.cgo.cgo_queue_duration_seconds.sum,count,,second,,Sum of the duration of milvus.cgo.running_cgo_call_total,gauge,,,,Total number of running cgo calls.,0,milvus,,, milvus.datacoord.channel_checkpoint_unix_seconds,gauge,,,,Channel checkpoint timestamp in Unix seconds,0,milvus,,, milvus.datacoord.collection_num,gauge,,,,Number of collections,0,milvus,,, -milvus.datacoord.consume_datanode_tt_lag_ms,gauge,,millisecond,,Now time minus tt per physical channel,0,milvus,,, +milvus.datacoord.consume_datanode_tt_lag_ms,gauge,,millisecond,,Now time minus time travel per physical channel,0,milvus,,, milvus.datacoord.datanode_num,gauge,,,,Number of data nodes,0,milvus,,, milvus.datacoord.import_tasks,gauge,,,,The import tasks grouping by type and state,0,milvus,,, milvus.datacoord.index.node_num,gauge,,,,Number of IndexNodes managed by IndexCoord,0,milvus,,, @@ -35,11 +35,11 @@ milvus.datacoord.stored.rows_num,gauge,,,,Number of stored rows of healthy segme milvus.datacoord.task_execute_max_latency.bucket,count,,,,Histogram bucket for the latency of task execute operation,0,milvus,,, milvus.datacoord.task_execute_max_latency.count,count,,,,Count of task execute operations,0,milvus,,, milvus.datacoord.task_execute_max_latency.sum,count,,millisecond,,Sum of the latency of task execute operations,0,milvus,,, -milvus.datacoord.watched_dml_chanel_num,gauge,,,,The num of dml channel watched by datanode,0,milvus,,, +milvus.datacoord.watched_dml_chanel_num,gauge,,,,The num of data manipulation language channel watched by datanode,0,milvus,,, milvus.datanode.autoflush_buffer_op.count,count,,,,Count of auto flush buffer operations,0,milvus,,, milvus.datanode.consume.bytes.count,count,,,,Count of consumed bytes,0,milvus,,, milvus.datanode.consume.msg.count,count,,,,Count of consumed msg,0,milvus,,, -milvus.datanode.consume.tt_lag_ms,gauge,,millisecond,,Now time minus tt per physical channel,0,milvus,,, +milvus.datanode.consume.tt_lag_ms,gauge,,millisecond,,Now time minus time travel per physical channel,0,milvus,,, milvus.datanode.encode_buffer_latency.bucket,count,,,,Histogram bucket for the latency of encode buffer data,0,milvus,,, milvus.datanode.encode_buffer_latency.count,count,,,,Count of encode buffer data operations,0,milvus,,, milvus.datanode.encode_buffer_latency.sum,count,,millisecond,,Sum of the latency of encode buffer data operations,0,milvus,,, @@ -112,7 +112,7 @@ milvus.go.memstats.stack.inuse_bytes,gauge,,,,Number of bytes in use by the stac milvus.go.memstats.stack.sys_bytes,gauge,,,,Number of bytes obtained from system for stack allocator.,0,milvus,,, milvus.go.memstats.sys_bytes,gauge,,,,Number of bytes obtained from system.,0,milvus,,, milvus.go.threads,gauge,,,,Number of OS threads created.,0,milvus,,, -milvus.graph_search_cnt.bucket,count,,,,Histogram bucket fot the number of graph search per request,0,milvus,,, +milvus.graph_search_cnt.bucket,count,,,,Histogram bucket for the number of graph search per request,0,milvus,,, milvus.graph_search_cnt.count,count,,,,Count of requests that trigger a graph search,0,milvus,,, milvus.graph_search_cnt.sum,count,,,,Sum of graph searches,0,milvus,,, milvus.hnsw.bitset_ratio.bucket,count,,,,Histogram bucket of the HNSW bitset ratio for search and range search,0,milvus,,, @@ -144,9 +144,9 @@ milvus.internal.mmap.allocated_space_bytes.bucket,count,,,,Histogram bucket for milvus.internal.mmap.allocated_space_bytes.count,count,,,,Count aggregation of [cpp]mmap allocated space stats,0,milvus,,, milvus.internal.mmap.allocated_space_bytes.sum,count,,,,Sum aggregation of [cpp]mmap allocated space stats,0,milvus,,, milvus.internal.mmap.in_used_space_bytes,gauge,,,,[cpp]mmap in used space stats,0,milvus,,, -milvus.internal.storage.kv_size.bucket,count,,,,Histogram bucket for the [cpp]kv size stats,0,milvus,,, -milvus.internal.storage.kv_size.count,count,,,,Count aggregation of [cpp]kv size stats,0,milvus,,, -milvus.internal.storage.kv_size.sum,count,,,,Sum aggregation of [cpp]kv size stats,0,milvus,,, +milvus.internal.storage.kv_size.bucket,count,,,,Histogram bucket for the [cpp]key-value size stats,0,milvus,,, +milvus.internal.storage.kv_size.count,count,,,,Count aggregation of [cpp]key-value size stats,0,milvus,,, +milvus.internal.storage.kv_size.sum,count,,,,Sum aggregation of [cpp]key-value size stats,0,milvus,,, milvus.internal.storage.load_duration.bucket,count,,,,Histogram bucket for the [cpp]durations of load segment,0,milvus,,, milvus.internal.storage.load_duration.count,count,,,,Count aggregation of [cpp]durations of load segment,0,milvus,,, milvus.internal.storage.load_duration.sum,count,,,,Sum aggregation of [cpp]durations of load segment,0,milvus,,, @@ -163,9 +163,9 @@ milvus.ivf_search_cnt.sum,count,,,,Sum of inverted file searches,0,milvus,,, milvus.load_latency.bucket,count,,,,Histogram bucket for the index load latency (ms),0,milvus,,, milvus.load_latency.count,count,,,,Count of index load events,0,milvus,,, milvus.load_latency.sum,count,,millisecond,,Sum of index load latency (ms),0,milvus,,, -milvus.meta.kv_size.bucket,count,,,,Histogram for the kv size stats,0,milvus,,, -milvus.meta.kv_size.count,count,,,,Count aggregation of the kv size stats,0,milvus,,, -milvus.meta.kv_size.sum,count,,,,Sum aggregation of the kv size stats,0,milvus,,, +milvus.meta.kv_size.bucket,count,,,,Histogram for the key-value size stats,0,milvus,,, +milvus.meta.kv_size.count,count,,,,Count aggregation of the key-value size stats,0,milvus,,, +milvus.meta.kv_size.sum,count,,,,Sum aggregation of the key-value size stats,0,milvus,,, milvus.meta.op.count,count,,,,Count of meta operation,0,milvus,,, milvus.meta.request_latency.bucket,count,,,,Histogram bucket for the request latency on the client side,0,milvus,,, milvus.meta.request_latency.count,count,,,,Count aggregation of the request latency on the client side,0,milvus,,, @@ -180,27 +180,27 @@ milvus.process.cpu_seconds.count,count,,,,Total user and system CPU time spent i milvus.process.max_fds,gauge,,,,Maximum number of open file descriptors.,0,milvus,,, milvus.process.open_fds,gauge,,,,Number of open file descriptors.,0,milvus,,, milvus.process.resident_memory_bytes,gauge,,,,Resident memory size in bytes.,0,milvus,,, -milvus.process.start_time_seconds,gauge,,,,Start time of the process since unix epoch in seconds.,0,milvus,,, +milvus.process.start_time_seconds,gauge,,,,Start time of the process since Unix epoch in seconds.,0,milvus,,, milvus.process.virtual_memory.bytes,gauge,,,,Virtual memory size in bytes.,0,milvus,,, milvus.process.virtual_memory.max_bytes,gauge,,,,Maximum amount of virtual memory available in bytes.,0,milvus,,, -milvus.proxy.apply.pk_latency.bucket,count,,,,Histogram bucket for the latency of "apply primary key" events,0,milvus,,, -milvus.proxy.apply.pk_latency.count,count,,,,Count of "apply primary key" events,0,milvus,,, -milvus.proxy.apply.pk_latency.sum,count,,millisecond,,Sum of latencies for "apply primary key" events,0,milvus,,, -milvus.proxy.apply.timestamp_latency.bucket,count,,,,Histogram bucket for the latency of proxy "apply timestamp" events,0,milvus,,, -milvus.proxy.apply.timestamp_latency.count,count,,,,Count of proxy "apply timestamp" events,0,milvus,,, -milvus.proxy.apply.timestamp_latency.sum,count,,millisecond,,Sum of latencies of proxy "apply timestamp" events,0,milvus,,, -milvus.proxy.assign_segmentID_latency.bucket,count,,,,Histogram bucket for the latency of proxy "get segmentID from dataCoord" events,0,milvus,,, -milvus.proxy.assign_segmentID_latency.count,count,,,,Count of proxy "get segmentID from dataCoord" events,0,milvus,,, -milvus.proxy.assign_segmentID_latency.sum,count,,millisecond,,Sum of latencies for proxy "get segmentID from dataCoord" events,0,milvus,,, +milvus.proxy.apply.pk_latency.bucket,count,,,,"Histogram bucket for the latency of 'apply primary key' events",0,milvus,,, +milvus.proxy.apply.pk_latency.count,count,,,,"Count of 'apply primary key' events",0,milvus,,, +milvus.proxy.apply.pk_latency.sum,count,,millisecond,,"Sum of latencies for 'apply primary key' events",0,milvus,,, +milvus.proxy.apply.timestamp_latency.bucket,count,,,,"Histogram bucket for the latency of proxy 'apply timestamp' events",0,milvus,,, +milvus.proxy.apply.timestamp_latency.count,count,,,,"Count of proxy 'apply timestamp' events",0,milvus,,, +milvus.proxy.apply.timestamp_latency.sum,count,,millisecond,,"Sum of latencies of proxy 'apply timestamp' events",0,milvus,,, +milvus.proxy.assign_segmentID_latency.bucket,count,,,,"Histogram bucket for the latency of proxy 'get segmentID from dataCoord' events",0,milvus,,, +milvus.proxy.assign_segmentID_latency.count,count,,,,"Count of proxy 'get segmentID from dataCoord' events",0,milvus,,, +milvus.proxy.assign_segmentID_latency.sum,count,,millisecond,,"Sum of latencies for proxy 'get segmentID from dataCoord' events",0,milvus,,, milvus.proxy.cache.hit.count,count,,,,Count of cache hits/miss,0,milvus,,, -milvus.proxy.cache.update_latency.bucket,count,,,,Histogram bucket for the latency of proxy "update cache when cache miss" events,0,milvus,,, -milvus.proxy.cache.update_latency.count,count,,,,Count of proxy "update cache when cache miss" events,0,milvus,,, -milvus.proxy.cache.update_latency.sum,count,,millisecond,,Sum of latencies of proxy "update cache when cache miss",0,milvus,,, +milvus.proxy.cache.update_latency.bucket,count,,,,"Histogram bucket for the latency of proxy 'update cache when cache miss' events",0,milvus,,, +milvus.proxy.cache.update_latency.count,count,,,,"Count of proxy 'update cache when cache miss' events",0,milvus,,, +milvus.proxy.cache.update_latency.sum,count,,millisecond,,"Sum of latencies of proxy 'update cache when cache miss'",0,milvus,,, milvus.proxy.delete_vectors.count,count,,,,Counter of vectors successfully deleted,0,milvus,,, milvus.proxy.msgstream_obj_num,gauge,,,,Number of MsgStream objects per physical channel,0,milvus,,, -milvus.proxy.mutation_send_latency.bucket,count,,,,Histogram bucket for the latency of proxy "send insert request to MsgStream" events,0,milvus,,, -milvus.proxy.mutation_send_latency.count,count,,,,Count of proxy "send insert request to MsgStream" events,0,milvus,,, -milvus.proxy.mutation_send_latency.sum,count,,millisecond,,Sum of latencies of proxy "send insert request to MsgStream" events,0,milvus,,, +milvus.proxy.mutation_send_latency.bucket,count,,,,"Histogram bucket for the latency of proxy 'send insert request to MsgStream' events",0,milvus,,, +milvus.proxy.mutation_send_latency.count,count,,,,"Count of proxy 'send insert request to MsgStream' events",0,milvus,,, +milvus.proxy.mutation_send_latency.sum,count,,millisecond,,"Sum of latencies of proxy 'send insert request to MsgStream' events",0,milvus,,, milvus.proxy.rate_limit_req.count,count,,,,Count of operation executed,0,milvus,,, milvus.proxy.report_value.count,count,,,,Report value about the request,0,milvus,,, milvus.proxy.req.count,count,,,,Count of operation executed,0,milvus,,, @@ -211,24 +211,24 @@ milvus.proxy.req.latency.bucket,count,,,,Histogram bucket for the latency of eac milvus.proxy.req.latency.count,count,,,,Count of request latency events,0,milvus,,, milvus.proxy.req.latency.sum,count,,millisecond,,Sum of latencies of requests,0,milvus,,, milvus.proxy.send_bytes.count,count,,,,Count of bytes sent back to sdk,0,milvus,,, -milvus.proxy.sq.decode_result_latency.bucket,count,,,,Histogram bucket for the latency of proxy "decode the search result" events,0,milvus,,, -milvus.proxy.sq.decode_result_latency.count,count,,,,Count of proxy "decode the search result" events,0,milvus,,, -milvus.proxy.sq.decode_result_latency.sum,count,,millisecond,,Sum of latencies for proxy "decode the search result" events,0,milvus,,, -milvus.proxy.sq.reduce_result_latency.bucket,count,,,,Histogram bucket for the latency of proxy "reduces search result" events,0,milvus,,, -milvus.proxy.sq.reduce_result_latency.count,count,,,,Count of proxy "reduces search result" events,0,milvus,,, -milvus.proxy.sq.reduce_result_latency.sum,count,,millisecond,,Sum of latencies for proxy "reduces search result" events,0,milvus,,, -milvus.proxy.sq.wait_result_latency.bucket,count,,,,Histogram bucket for the latency of proxy "waits for the result" events,0,milvus,,, -milvus.proxy.sq.wait_result_latency.count,count,,,,Count of proxy "waits for the result" events,0,milvus,,, -milvus.proxy.sq.wait_result_latency.sum,count,,millisecond,,Sum of latencies for proxy "waits for the result" events,0,milvus,,, +milvus.proxy.sq.decode_result_latency.bucket,count,,,,"Histogram bucket for the latency of proxy 'decode the search result' events",0,milvus,,, +milvus.proxy.sq.decode_result_latency.count,count,,,,"Count of proxy 'decode the search result' events",0,milvus,,, +milvus.proxy.sq.decode_result_latency.sum,count,,millisecond,,"Sum of latencies for proxy 'decode the search result' events",0,milvus,,, +milvus.proxy.sq.reduce_result_latency.bucket,count,,,,"Histogram bucket for the latency of proxy 'reduces search result' events",0,milvus,,, +milvus.proxy.sq.reduce_result_latency.count,count,,,,"Count of proxy 'reduces search result' events",0,milvus,,, +milvus.proxy.sq.reduce_result_latency.sum,count,,millisecond,,"Sum of latencies for proxy 'reduces search result' events",0,milvus,,, +milvus.proxy.sq.wait_result_latency.bucket,count,,,,"Histogram bucket for the latency of proxy 'waits for the result' events",0,milvus,,, +milvus.proxy.sq.wait_result_latency.count,count,,,,"Count of proxy 'waits for the result' events",0,milvus,,, +milvus.proxy.sq.wait_result_latency.sum,count,,millisecond,,"Sum of latencies for proxy 'waits for the result' events",0,milvus,,, milvus.proxy.sync_segment_request_length.bucket,count,,,,Histogram bucket for the length of SegmentIDRequests when assigning segments for insert,0,milvus,,, milvus.proxy.sync_segment_request_length.count,count,,,,Count of assigning segments for insert events,0,milvus,,, milvus.proxy.sync_segment_request_length.sum,count,,,,Sum of the length of SegmentIDRequests when assigning segments for insert,0,milvus,,, -milvus.proxy.tt_lag_ms,gauge,,millisecond,,Now time minus tt per physical channel,0,milvus,,, +milvus.proxy.tt_lag_ms,gauge,,millisecond,,Now time minus time travel per physical channel,0,milvus,,, milvus.quant.compute_cnt.bucket,count,,,,Histogram bucket for the quant compute count per request,0,milvus,,, milvus.quant.compute_cnt.count,count,,,,Count of requests triggering quant compute events,0,milvus,,, milvus.quant.compute_cnt.sum,count,,,,Sum of quant compute event counts,0,milvus,,, milvus.querycoord.collection_num,gauge,,,,Number of collections,0,milvus,,, -milvus.querycoord.current_target_checkpoint_unix_seconds,gauge,,,,Current target checkpoint timestamp in unix seconds,0,milvus,,, +milvus.querycoord.current_target_checkpoint_unix_seconds,gauge,,,,Current target checkpoint timestamp in Unix seconds,0,milvus,,, milvus.querycoord.load.latency.bucket,count,,,,Histogram bucket Latency of load the entire collection,0,milvus,,, milvus.querycoord.load.latency.count,count,,,,Latency of load the entire collection,0,milvus,,, milvus.querycoord.load.latency.sum,count,,millisecond,,Latency of load the entire collection,0,milvus,,, @@ -244,9 +244,9 @@ milvus.querynode.apply_bf_latency.bucket,count,,,,Histogram bucket for the apply milvus.querynode.apply_bf_latency.count,count,,,,Count of apply brute-force events,0,milvus,,, milvus.querynode.apply_bf_latency.sum,count,,millisecond,,Sum of the apply brute-force cost in ms,0,milvus,,, milvus.querynode.collection_num,gauge,,,,Number of collections loaded,0,milvus,,, -milvus.querynode.consume.bytes_counter.count,count,,,,,0,milvus,,, +milvus.querynode.consume.bytes_counter.count,count,,,,Count of consumed bytes,0,milvus,,, milvus.querynode.consume.msg.count,count,,,,Count of consumed msg,0,milvus,,, -milvus.querynode.consume.tt_lag_ms,gauge,,millisecond,,Now time minus tt per physical channel,0,milvus,,, +milvus.querynode.consume.tt_lag_ms,gauge,,millisecond,,Now time minus time travel per physical channel,0,milvus,,, milvus.querynode.disk.cache.evict.bytes.count,count,,byte,,Number of bytes evicted from disk cache,0,milvus,,, milvus.querynode.disk.cache.evict.count,count,,,,Number of segments evicted from disk cache,0,milvus,,, milvus.querynode.disk.cache.evict.duration.count,count,,,,Total time cost of evicting segments from disk cache,0,milvus,,, @@ -260,10 +260,10 @@ milvus.querynode.disk.cache.load.global_duration.bucket,count,,,,Histogram bucke milvus.querynode.disk.cache.load.global_duration.count,count,,,,Count of loading segments from disk cache events,0,milvus,,, milvus.querynode.disk.cache.load.global_duration.sum,count,,millisecond,,Sum of the global duration of loading segments from disk cache,0,milvus,,, milvus.querynode.disk.used_size,gauge,,mebibyte,,Disk used size(MB),0,milvus,,, -milvus.querynode.dml_vchannel_num,gauge,,,,Number of dmlChannels watched,0,milvus,,, +milvus.querynode.dml_vchannel_num,gauge,,,,Number of data manipulation language channels watched,0,milvus,,, milvus.querynode.entity.num,gauge,,,,"Number of entities which can be searched/queried, clustered by collection, partition and state",0,milvus,,, milvus.querynode.entity.size,gauge,,byte,,"Entities' memory size, clustered by collection and state",0,milvus,,, -milvus.querynode.execute_bytes_counter.count,count,,,,,0,milvus,,, +milvus.querynode.execute_bytes_counter.count,count,,,,Count of execute bytes,0,milvus,,, milvus.querynode.flowgraph_num,gauge,,,,Number of flowgraphs,0,milvus,,, milvus.querynode.forward_delete_latency.bucket,count,,,,Histogram bucket for the forward delete cost in ms,0,milvus,,, milvus.querynode.forward_delete_latency.count,count,,,,Count of forward delete events,0,milvus,,, @@ -335,9 +335,9 @@ milvus.querynode.sq.wait_tsafe_latency.bucket,count,,,,Histogram bucket for the milvus.querynode.sq.wait_tsafe_latency.count,count,,,,Count of occurrences of search or query waiting for tsafe,0,milvus,,, milvus.querynode.sq.wait_tsafe_latency.sum,count,,millisecond,,Sum of the time that search or query wait for tsafe,0,milvus,,, milvus.querynode.wait_processing_msg,gauge,,,,Count of wait processing msg,0,milvus,,, -milvus.querynode.watch_dml_channel_latency.bucket,count,,,,Histogram bucket for the latencies of watch dml channel,0,milvus,,, -milvus.querynode.watch_dml_channel_latency.count,count,,,,Count of watch dml channel events,0,milvus,,, -milvus.querynode.watch_dml_channel_latency.sum,count,,millisecond,,Sum of the latencies of watch dml channel events,0,milvus,,, +milvus.querynode.watch_dml_channel_latency.bucket,count,,,,Histogram bucket for the latencies of watch data manipulation language channel,0,milvus,,, +milvus.querynode.watch_dml_channel_latency.count,count,,,,Count of watch data manipulation language channel events,0,milvus,,, +milvus.querynode.watch_dml_channel_latency.sum,count,,millisecond,,Sum of the latencies of watch data manipulation language channel events,0,milvus,,, milvus.queue.latency.bucket,count,,,,Histogram bucket for the queue latency per request,0,milvus,,, milvus.queue.latency.count,count,,,,Count of request with queue latency,0,milvus,,, milvus.queue.latency.sum,count,,,,Sum of queue latencies,0,milvus,,, @@ -367,7 +367,7 @@ milvus.rootcoord.indexed_entity_num,gauge,,,,"Indexed number of entities, cluste milvus.rootcoord.msgstream_obj_num,gauge,,,,Number of message streams,0,milvus,,, milvus.rootcoord.num_of_roles,gauge,,,,The number of roles,0,milvus,,, milvus.rootcoord.partition_num,gauge,,,,Number of partitions,0,milvus,,, -milvus.rootcoord.produce_tt_lag_ms,gauge,,millisecond,,Now time minus tt per physical channel,0,milvus,,, +milvus.rootcoord.produce_tt_lag_ms,gauge,,millisecond,,Now time minus time travel per physical channel,0,milvus,,, milvus.rootcoord.proxy_num,gauge,,,,Number of proxy nodes managered by rootcoord,0,milvus,,, milvus.rootcoord.qn_mem_high_water_level,gauge,,,,Querynode memory high water level,0,milvus,,, milvus.rootcoord.sync_timetick_latency.bucket,count,,,,Histogram bucket for the latencies of synchronizing timetick message,0,milvus,,, @@ -382,6 +382,6 @@ milvus.search.latency.sum,count,,millisecond,,Sum of search latencies (ms),0,mil milvus.search.topk.bucket,count,,,,Histogram bucket for search topk,0,milvus,,, milvus.search.topk.count,count,,,,Count aggregation of search topk,0,milvus,,, milvus.search.topk.sum,count,,,,Sum aggregation of search topk,0,milvus,,, -milvus.storage.kv_size,gauge,,,,Kv size stats,0,milvus,,, +milvus.storage.kv_size,gauge,,,,Key-value size stats,0,milvus,,, milvus.storage.op.count,count,,,,Count of persistent data operation,0,milvus,,, milvus.storage.request_latency,gauge,,,,Request latency on the client side,0,milvus,,,