Collect telemetry data

GET

/telemetry

GET

/telemetry

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

Try it

200Retrieved

1 {
2   "time": 1.1,
3   "status": "string",
4   "result": {
5     "id": "string",
6     "app": {
7       "name": "string",
8       "version": "string",
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         "distribution": "string",
18         "distribution_version": "string",
19         "is_docker": true,
20         "cores": 1,
21         "ram_size": 1,
22         "disk_size": 1,
23         "cpu_flags": "string"
24       },
25       "jwt_rbac": true
26     },
27     "collections": {
28       "number_of_collections": 1,
29       "collections": [
30         {
31           "id": "string",
32           "init_time_ms": 1,
33           "config": {
34             "params": {
35               "vectors": {},
36               "shard_number": 1,
37               "sharding_method": "auto",
38               "replication_factor": 1,
39               "write_consistency_factor": 1,
40               "read_fan_out_factor": 1,
41               "on_disk_payload": false,
42               "sparse_vectors": {}
43             },
44             "hnsw_config": {
45               "m": 1,
46               "ef_construct": 1,
47               "full_scan_threshold": 1,
48               "max_indexing_threads": 0,
49               "on_disk": true,
50               "payload_m": 1
51             },
52             "optimizer_config": {
53               "deleted_threshold": 1.1,
54               "vacuum_min_vector_number": 1,
55               "default_segment_number": 1,
56               "max_segment_size": 1,
57               "memmap_threshold": 1,
58               "indexing_threshold": 1,
59               "flush_interval_sec": 1,
60               "max_optimization_threads": 1
61             },
62             "wal_config": {
63               "wal_capacity_mb": 1,
64               "wal_segments_ahead": 1
65             },
66             "quantization_config": {
67               "scalar": {
68                 "type": "int8",
69                 "quantile": 1.1,
70                 "always_ram": true
71               }
72             }
73           },
74           "shards": [
75             {
76               "id": 1,
77               "local": {
78                 "variant_name": "string",
79                 "segments": [
80                   {
81                     "info": {
82                       "segment_type": "plain",
83                       "num_vectors": 1,
84                       "num_points": 1,
85                       "num_indexed_vectors": 1,
86                       "num_deleted_vectors": 1,
87                       "ram_usage_bytes": 1,
88                       "disk_usage_bytes": 1,
89                       "is_appendable": true,
90                       "index_schema": {},
91                       "vector_data": {}
92                     },
93                     "config": {
94                       "vector_data": {},
95                       "sparse_vector_data": {},
96                       "payload_storage_type": {
97                         "type": "in_memory"
98                       }
99                     },
100                     "vector_index_searches": [
101                       {
102                         "index_name": "string",
103                         "unfiltered_plain": {
104                           "count": 1,
105                           "fail_count": 1,
106                           "avg_duration_micros": 1.1,
107                           "min_duration_micros": 1.1,
108                           "max_duration_micros": 1.1,
109                           "total_duration_micros": 1,
110                           "last_responded": "2024-01-15T09:30:00Z"
111                         },
112                         "unfiltered_hnsw": {
113                           "count": 1,
114                           "fail_count": 1,
115                           "avg_duration_micros": 1.1,
116                           "min_duration_micros": 1.1,
117                           "max_duration_micros": 1.1,
118                           "total_duration_micros": 1,
119                           "last_responded": "2024-01-15T09:30:00Z"
120                         },
121                         "unfiltered_sparse": {
122                           "count": 1,
123                           "fail_count": 1,
124                           "avg_duration_micros": 1.1,
125                           "min_duration_micros": 1.1,
126                           "max_duration_micros": 1.1,
127                           "total_duration_micros": 1,
128                           "last_responded": "2024-01-15T09:30:00Z"
129                         },
130                         "filtered_plain": {
131                           "count": 1,
132                           "fail_count": 1,
133                           "avg_duration_micros": 1.1,
134                           "min_duration_micros": 1.1,
135                           "max_duration_micros": 1.1,
136                           "total_duration_micros": 1,
137                           "last_responded": "2024-01-15T09:30:00Z"
138                         },
139                         "filtered_small_cardinality": {
140                           "count": 1,
141                           "fail_count": 1,
142                           "avg_duration_micros": 1.1,
143                           "min_duration_micros": 1.1,
144                           "max_duration_micros": 1.1,
145                           "total_duration_micros": 1,
146                           "last_responded": "2024-01-15T09:30:00Z"
147                         },
148                         "filtered_large_cardinality": {
149                           "count": 1,
150                           "fail_count": 1,
151                           "avg_duration_micros": 1.1,
152                           "min_duration_micros": 1.1,
153                           "max_duration_micros": 1.1,
154                           "total_duration_micros": 1,
155                           "last_responded": "2024-01-15T09:30:00Z"
156                         },
157                         "filtered_exact": {
158                           "count": 1,
159                           "fail_count": 1,
160                           "avg_duration_micros": 1.1,
161                           "min_duration_micros": 1.1,
162                           "max_duration_micros": 1.1,
163                           "total_duration_micros": 1,
164                           "last_responded": "2024-01-15T09:30:00Z"
165                         },
166                         "filtered_sparse": {
167                           "count": 1,
168                           "fail_count": 1,
169                           "avg_duration_micros": 1.1,
170                           "min_duration_micros": 1.1,
171                           "max_duration_micros": 1.1,
172                           "total_duration_micros": 1,
173                           "last_responded": "2024-01-15T09:30:00Z"
174                         },
175                         "unfiltered_exact": {
176                           "count": 1,
177                           "fail_count": 1,
178                           "avg_duration_micros": 1.1,
179                           "min_duration_micros": 1.1,
180                           "max_duration_micros": 1.1,
181                           "total_duration_micros": 1,
182                           "last_responded": "2024-01-15T09:30:00Z"
183                         }
184                       }
185                     ],
186                     "payload_field_indices": [
187                       {
188                         "field_name": "string",
189                         "points_values_count": 1,
190                         "points_count": 1,
191                         "histogram_bucket_size": 1
192                       }
193                     ]
194                   }
195                 ],
196                 "optimizations": {
197                   "status": "ok",
198                   "optimizations": {
199                     "count": 1,
200                     "fail_count": 1,
201                     "avg_duration_micros": 1.1,
202                     "min_duration_micros": 1.1,
203                     "max_duration_micros": 1.1,
204                     "total_duration_micros": 1,
205                     "last_responded": "2024-01-15T09:30:00Z"
206                   },
207                   "log": [
208                     {
209                       "name": "string",
210                       "segment_ids": [
211                         1
212                       ],
213                       "status": "optimizing",
214                       "start_at": "2024-01-15T09:30:00Z",
215                       "end_at": "2024-01-15T09:30:00Z"
216                     }
217                   ]
218                 }
219               },
220               "remote": [
221                 {
222                   "shard_id": 1,
223                   "peer_id": 1,
224                   "searches": {
225                     "count": 1,
226                     "fail_count": 1,
227                     "avg_duration_micros": 1.1,
228                     "min_duration_micros": 1.1,
229                     "max_duration_micros": 1.1,
230                     "total_duration_micros": 1,
231                     "last_responded": "2024-01-15T09:30:00Z"
232                   },
233                   "updates": {
234                     "count": 1,
235                     "fail_count": 1,
236                     "avg_duration_micros": 1.1,
237                     "min_duration_micros": 1.1,
238                     "max_duration_micros": 1.1,
239                     "total_duration_micros": 1,
240                     "last_responded": "2024-01-15T09:30:00Z"
241                   }
242                 }
243               ],
244               "replicate_states": {}
245             }
246           ],
247           "transfers": [
248             {
249               "shard_id": 1,
250               "from": 1,
251               "to": 1,
252               "sync": true,
253               "method": "stream_records",
254               "comment": "string"
255             }
256           ]
257         }
258       ]
259     },
260     "cluster": {
261       "enabled": true,
262       "status": {
263         "number_of_peers": 1,
264         "term": 1,
265         "commit": 1,
266         "pending_operations": 1,
267         "role": "Follower",
268         "is_voter": true,
269         "peer_id": 1,
270         "consensus_thread_status": {
271           "consensus_thread_status": "working",
272           "last_update": "2024-01-15T09:30:00Z"
273         }
274       },
275       "config": {
276         "grpc_timeout_ms": 1,
277         "p2p": {
278           "connection_pool_size": 1
279         },
280         "consensus": {
281           "max_message_queue_size": 1,
282           "tick_period_ms": 1,
283           "bootstrap_timeout_sec": 1
284         }
285       }
286     },
287     "requests": {
288       "rest": {
289         "responses": {}
290       },
291       "grpc": {
292         "responses": {}
293       }
294     }
295   }
296 }

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

Authentication

api-keystring

API Key authentication via header

Query parameters

anonymizebooleanOptional

If true, anonymize result

Response

successful operation

timedouble or null

Time spent to process this request

statusstring or null

resultobject or null