Collects telemetry data, such as: application info, system info, collection info, cluster info, configs and statistics.

name

Collect telemetry data

Retrieve instance details

Update cluster setup

AppBuildTelemetry

AppBuildTelemetryFeatures

AppBuildTelemetrySystem

AppFeaturesTelemetry

BinaryQuantization

BinaryQuantizationConfig

ClusterConfigTelemetry

ClusterStatusTelemetry

ClusterStatusTelemetryRole

ClusterTelemetry

ClusterTelemetryConfig

ClusterTelemetryStatus

CollectionConfig

CollectionConfigQuantizationConfig

CollectionParams

Sharding method Default is Auto - points are distributed across all available shards Custom - points are distributed across shards according to shard key

Defines how many replicas should apply the operation for us to consider it successful. Increasing this number will make the collection more resilient to inconsistencies, but will also make it fail if not enough replicas are available. Does not have any performance impact.

Defines how many additional replicas should be processing read request at the same time. Default value is Auto, which means that fan-out will be determined automatically based on the busyness of the local replica. Having more than 0 might be useful to smooth latency spikes of individual nodes.

If true - point's payload will not be stored in memory. It will be read from the disk every time it is requested. This setting saves RAM by (slightly) increasing the response time. Note: those payload values that are involved in filtering and are indexed - remain in RAM.

Configuration of the sparse vector storage

CollectionParamsShardingMethod

CollectionTelemetry

CollectionTelemetryEnum

CollectionsAggregatedTelemetry

CollectionsTelemetry

CompressionRatio

ConsensusConfigTelemetry

Information about current consensus thread status

ConsensusThreadStatus

ConsensusThreadStatusStopped

ConsensusThreadStatusStoppedWithErr

ConsensusThreadStatusWorking

Datatype

Type of internal tags, build from payload Distance function types used to compare vectors

Distance

GrpcTelemetry

HnswConfig

Number of edges per node in the index graph. Larger the value - more accurate the search, more space required.

Number of neighbours to consider during the index building. Larger the value - more accurate the search, more time required to build index.

Number of parallel threads used for background index building. If 0 - automatically select from 8 to 16. Best to keep between 8 and 16 to prevent likelihood of slow building or broken/inefficient HNSW graphs. On small CPUs, less threads are used.

Store HNSW index on disk. If set to false, index will be stored in RAM. Default: false

Custom M param for hnsw graph built for payload index. If not set, default M will be used.

HnswConfigDiff

Number of neighbours to consider during the index building. Larger the value - more accurate the search, more time required to build the index.

Number of parallel threads used for background index building. If 0 - automatically select from 8 to 16. Best to keep between 8 and 16 to prevent likelihood of building broken/inefficient HNSW graphs. On small CPUs, less threads are used.

Store HNSW index on disk. If set to false, the index will be stored in RAM. Default: false

Custom M param for additional payload-aware HNSW links. If not set, default M will be used.

Indexes

Do not use any index, scan whole vector collection during search. Guarantee 100% precision, but may be time consuming on large collections.

Use filterable HNSW index for approximate search. Is very fast even on a very huge collections, but require additional space to store index and additional time to build it.

IndexesHnsw

IndexesPlain

IntegerIndexParams

LocalShardTelemetry

MaxSimConfig

MultiVectorConfig

OperationDurationStatistics

The average time taken by 128 latest operations, calculated as a weighted mean.

The minimum duration of the operations across all the measurements.

The maximum duration of the operations across all the measurements.

The total duration of all operations in microseconds.

OptimizerTelemetry

OptimizersConfig

The minimal fraction of deleted vectors in a segment, required to perform segment optimization

The minimal number of vectors in a segment, required to perform segment optimization

Maximum size (in kilobytes) of vectors allowed for plain index, exceeding this threshold will enable vector indexing

Default value is 20,000, based on <https://github.com/google-research/google-research/blob/master/scann/docs/algorithms.md>.

To disable vector indexing, set to `0`.

Note: 1kB = 1 vector of size 256.

OptimizersStatus

OptimizersStatusError

P2PConfigTelemetry

Display payload field type & index information

PayloadIndexInfo

PayloadIndexInfoParams

PayloadIndexTelemetry

PayloadSchemaParams

PayloadSchemaType

PayloadStorageType

PayloadStorageTypeInMemory

PayloadStorageTypeOnDisk

ProductQuantization

ProductQuantizationConfig

QuantizationConfig

RemoteShardTelemetry

ReplicaSetTelemetry

ReplicaSetTelemetryLocal

State of the single shard within a replica set.

ReplicaState

RequestsTelemetry

RunningEnvironmentTelemetry

ScalarQuantization

ScalarQuantizationConfig

Quantile for quantization. Expected value range in [0.5, 1.0]. If not set - use the whole range of values

If true - quantized vectors always will be stored in RAM, ignoring the config of main storage

ScalarType

SegmentConfig

SegmentInfo

SegmentTelemetry

SegmentType

ShardTransferInfo

A human-readable report of the transfer progress. Available only on the source peer.

ShardTransferInfoMethod

Methods for transferring a shard from one node to another.

ShardTransferMethod

ShardingMethod

SparseIndexConfig

SparseIndexParams

Store index on disk. If set to false, the index will be stored in RAM. Default: false

SparseIndexType

Config of single sparse vector data storage

SparseVectorDataConfig

Params of single sparse vector data storage

SparseVectorParams

Custom params for index. If none - values from collection configuration are used.

SparseVectorParamsIndex

StateRole

TelemetryData

TextIndexParams

If true, lowercase all tokens. Default: true

TokenizerType

Represents the current state of the optimizer being tracked

TrackerStatus

TrackerStatusCancelled

TrackerStatusError

TrackerTelemetry

VectorDataConfig

Vector specific quantization config that overrides collection config

Vector specific configuration to enable multiple vectors per point

Vector specific configuration to set specific storage element type

VectorDataConfigDatatype

VectorDataConfigMultiVecConfig

VectorDataConfigQuantizationConfig

VectorDataInfo

VectorIndexSearchesTelemetry

VectorParams

Custom params for HNSW index. If none - values from collection configuration are used.

Custom params for quantization. If none - values from collection configuration are used.

If true, vectors are served from disk, improving RAM usage at the cost of latency Default: false

VectorParamsDatatype

VectorParamsHnswConfig

VectorParamsQuantizationConfig

VectorStorageDatatype

VectorStorageType

Vector params separator for single and multiple vector modes Single mode:

{ "size": 128, "distance": "Cosine" }

or multiple mode:

{ "default": { "size": 128, "distance": "Cosine" } }

1	{
2	"time": 1.1,
3	"status": "status",
4	"result": {
5	"id": "id",
6	"app": {
7	"name": "name",
8	"version": "version",
9	"startup": "2024-01-15T09:30:00Z",
10	"features": {
11	"debug": true,
12	"web_feature": true,
13	"service_debug_feature": true,
14	"recovery_mode": true
15	},
16	"system": {
17	"is_docker": true,
18	"cpu_flags": "cpu_flags"
19	},
20	"jwt_rbac": true
21	},
22	"collections": {
23	"number_of_collections": 1,
24	"collections": [
25	{
26	"id": "id",
27	"init_time_ms": 1,
28	"config": {
29	"params": {},
30	"hnsw_config": {
31	"m": 1,
32	"ef_construct": 1,
33	"full_scan_threshold": 1
34	},
35	"optimizer_config": {
36	"deleted_threshold": 1.1,
37	"vacuum_min_vector_number": 1,
38	"default_segment_number": 1,
39	"flush_interval_sec": 1
40	},
41	"wal_config": {
42	"wal_capacity_mb": 1,
43	"wal_segments_ahead": 1
44	}
45	},
46	"shards": [
47	{
48	"id": 1,
49	"remote": [
50	{
51	"shard_id": 1,
52	"searches": {
53	"count": 1,
54	"total_duration_micros": 1
55	},
56	"updates": {
57	"count": 1,
58	"total_duration_micros": 1
59	}
60	}
61	],
62	"replicate_states": {
63	"replicate_states": "Active"
64	}
65	}
66	],
67	"transfers": [
68	{
69	"shard_id": 1,
70	"from": 1,
71	"to": 1,
72	"sync": true
73	}
74	]
75	}
76	]
77	},
78	"cluster": {
79	"enabled": true,
80	"status": {
81	"number_of_peers": 1,
82	"term": 1,
83	"commit": 1,
84	"pending_operations": 1,
85	"is_voter": true,
86	"consensus_thread_status": {
87	"consensus_thread_status": "working",
88	"last_update": "2024-01-15T09:30:00Z"
89	}
90	},
91	"config": {
92	"grpc_timeout_ms": 1,
93	"p2p": {
94	"connection_pool_size": 1
95	},
96	"consensus": {
97	"max_message_queue_size": 1,
98	"tick_period_ms": 1,
99	"bootstrap_timeout_sec": 1
100	}
101	}
102	},
103	"requests": {
104	"rest": {
105	"responses": {
106	"responses": {
107	"responses": {
108	"count": 1,
109	"total_duration_micros": 1
110	}
111	}
112	}
113	},
114	"grpc": {
115	"responses": {
116	"responses": {
117	"count": 1,
118	"total_duration_micros": 1
119	}
120	}
121	}
122	}
123	}
124	}

Collect telemetry data

Query parameters

Response

1	curl http://localhost:6333/telemetry \
2	-H "api-key: <apiKey>"