Collect telemetry data

GET

/telemetry

GET

/telemetry

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

200Retrieved

1 {
2   "usage": {
3     "hardware": {
4       "cpu": 1,
5       "payload_io_read": 1,
6       "payload_io_write": 1,
7       "payload_index_io_read": 1,
8       "payload_index_io_write": 1,
9       "vector_io_read": 1,
10       "vector_io_write": 1
11     },
12     "inference": {
13       "models": {}
14     }
15   },
16   "time": 0.002,
17   "status": "ok",
18   "result": {
19     "id": "string",
20     "collections": {
21       "number_of_collections": 1,
22       "max_collections": 1,
23       "collections": [
24         {
25           "id": "string",
26           "init_time_ms": 1,
27           "config": {
28             "params": {
29               "vectors": {},
30               "shard_number": 1,
31               "sharding_method": "auto",
32               "replication_factor": 1,
33               "write_consistency_factor": 1,
34               "read_fan_out_factor": 1,
35               "read_fan_out_delay_ms": 1,
36               "on_disk_payload": true,
37               "sparse_vectors": {}
38             },
39             "hnsw_config": {
40               "m": 1,
41               "ef_construct": 1,
42               "full_scan_threshold": 1,
43               "max_indexing_threads": 0,
44               "on_disk": true,
45               "payload_m": 1,
46               "inline_storage": true
47             },
48             "optimizer_config": {
49               "deleted_threshold": 1.1,
50               "vacuum_min_vector_number": 1,
51               "default_segment_number": 1,
52               "max_segment_size": 1,
53               "memmap_threshold": 1,
54               "indexing_threshold": 1,
55               "flush_interval_sec": 1,
56               "max_optimization_threads": 1,
57               "prevent_unoptimized": true
58             },
59             "wal_config": {
60               "wal_capacity_mb": 1,
61               "wal_segments_ahead": 1,
62               "wal_retain_closed": 1
63             },
64             "quantization_config": {
65               "scalar": {
66                 "type": "int8",
67                 "quantile": 1.1,
68                 "always_ram": true
69               }
70             },
71             "strict_mode_config": {
72               "enabled": true,
73               "max_query_limit": 1,
74               "max_timeout": 1,
75               "unindexed_filtering_retrieve": true,
76               "unindexed_filtering_update": true,
77               "search_max_hnsw_ef": 1,
78               "search_allow_exact": true,
79               "search_max_oversampling": 1.1,
80               "upsert_max_batchsize": 1,
81               "max_collection_vector_size_bytes": 1,
82               "read_rate_limit": 1,
83               "write_rate_limit": 1,
84               "max_collection_payload_size_bytes": 1,
85               "max_points_count": 1,
86               "filter_max_conditions": 1,
87               "condition_max_size": 1,
88               "multivector_config": {},
89               "sparse_config": {},
90               "max_payload_index_count": 1
91             },
92             "uuid": "string",
93             "metadata": {}
94           },
95           "shards": [
96             {
97               "id": 1,
98               "key": "region_1",
99               "local": {
100                 "variant_name": "string",
101                 "status": "green",
102                 "total_optimized_points": 1,
103                 "vectors_size_bytes": 1,
104                 "payloads_size_bytes": 1,
105                 "num_points": 1,
106                 "num_vectors": 1,
107                 "num_vectors_by_name": {},
108                 "segments": [
109                   {
110                     "info": {
111                       "uuid": "string",
112                       "segment_type": "plain",
113                       "num_vectors": 1,
114                       "num_points": 1,
115                       "num_indexed_vectors": 1,
116                       "num_deleted_vectors": 1,
117                       "vectors_size_bytes": 1,
118                       "payloads_size_bytes": 1,
119                       "ram_usage_bytes": 1,
120                       "disk_usage_bytes": 1,
121                       "is_appendable": true,
122                       "index_schema": {},
123                       "vector_data": {}
124                     },
125                     "config": {
126                       "vector_data": {},
127                       "sparse_vector_data": {},
128                       "payload_storage_type": {
129                         "type": "in_memory"
130                       }
131                     },
132                     "vector_index_searches": [
133                       {
134                         "index_name": "string",
135                         "unfiltered_plain": {
136                           "count": 1,
137                           "fail_count": 1,
138                           "avg_duration_micros": 1.1,
139                           "min_duration_micros": 1.1,
140                           "max_duration_micros": 1.1,
141                           "total_duration_micros": 1,
142                           "last_responded": "2024-01-15T09:30:00Z"
143                         },
144                         "unfiltered_hnsw": {
145                           "count": 1,
146                           "fail_count": 1,
147                           "avg_duration_micros": 1.1,
148                           "min_duration_micros": 1.1,
149                           "max_duration_micros": 1.1,
150                           "total_duration_micros": 1,
151                           "last_responded": "2024-01-15T09:30:00Z"
152                         },
153                         "unfiltered_sparse": {
154                           "count": 1,
155                           "fail_count": 1,
156                           "avg_duration_micros": 1.1,
157                           "min_duration_micros": 1.1,
158                           "max_duration_micros": 1.1,
159                           "total_duration_micros": 1,
160                           "last_responded": "2024-01-15T09:30:00Z"
161                         },
162                         "filtered_plain": {
163                           "count": 1,
164                           "fail_count": 1,
165                           "avg_duration_micros": 1.1,
166                           "min_duration_micros": 1.1,
167                           "max_duration_micros": 1.1,
168                           "total_duration_micros": 1,
169                           "last_responded": "2024-01-15T09:30:00Z"
170                         },
171                         "filtered_small_cardinality": {
172                           "count": 1,
173                           "fail_count": 1,
174                           "avg_duration_micros": 1.1,
175                           "min_duration_micros": 1.1,
176                           "max_duration_micros": 1.1,
177                           "total_duration_micros": 1,
178                           "last_responded": "2024-01-15T09:30:00Z"
179                         },
180                         "filtered_large_cardinality": {
181                           "count": 1,
182                           "fail_count": 1,
183                           "avg_duration_micros": 1.1,
184                           "min_duration_micros": 1.1,
185                           "max_duration_micros": 1.1,
186                           "total_duration_micros": 1,
187                           "last_responded": "2024-01-15T09:30:00Z"
188                         },
189                         "filtered_exact": {
190                           "count": 1,
191                           "fail_count": 1,
192                           "avg_duration_micros": 1.1,
193                           "min_duration_micros": 1.1,
194                           "max_duration_micros": 1.1,
195                           "total_duration_micros": 1,
196                           "last_responded": "2024-01-15T09:30:00Z"
197                         },
198                         "filtered_sparse": {
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                         "unfiltered_exact": {
208                           "count": 1,
209                           "fail_count": 1,
210                           "avg_duration_micros": 1.1,
211                           "min_duration_micros": 1.1,
212                           "max_duration_micros": 1.1,
213                           "total_duration_micros": 1,
214                           "last_responded": "2024-01-15T09:30:00Z"
215                         }
216                       }
217                     ],
218                     "payload_field_indices": [
219                       {
220                         "field_name": "string",
221                         "index_type": "string",
222                         "points_values_count": 1,
223                         "points_count": 1,
224                         "histogram_bucket_size": 1
225                       }
226                     ]
227                   }
228                 ],
229                 "optimizations": {
230                   "status": "ok",
231                   "optimizations": {
232                     "count": 1,
233                     "fail_count": 1,
234                     "avg_duration_micros": 1.1,
235                     "min_duration_micros": 1.1,
236                     "max_duration_micros": 1.1,
237                     "total_duration_micros": 1,
238                     "last_responded": "2024-01-15T09:30:00Z"
239                   },
240                   "log": [
241                     {
242                       "name": "string",
243                       "uuid": "string",
244                       "segment_ids": [
245                         1
246                       ],
247                       "segment_uuids": [
248                         "string"
249                       ],
250                       "status": {
251                         "cancelled": {}
252                       },
253                       "start_at": "2024-01-15T09:30:00Z",
254                       "end_at": "2024-01-15T09:30:00Z"
255                     }
256                   ]
257                 },
258                 "async_scorer": true,
259                 "indexed_only_excluded_vectors": {},
260                 "update_queue": {
261                   "length": 1,
262                   "op_num": 1
263                 }
264               },
265               "remote": [
266                 {
267                   "shard_id": 1,
268                   "peer_id": 1,
269                   "searches": {
270                     "count": 1,
271                     "fail_count": 1,
272                     "avg_duration_micros": 1.1,
273                     "min_duration_micros": 1.1,
274                     "max_duration_micros": 1.1,
275                     "total_duration_micros": 1,
276                     "last_responded": "2024-01-15T09:30:00Z"
277                   },
278                   "updates": {
279                     "count": 1,
280                     "fail_count": 1,
281                     "avg_duration_micros": 1.1,
282                     "min_duration_micros": 1.1,
283                     "max_duration_micros": 1.1,
284                     "total_duration_micros": 1,
285                     "last_responded": "2024-01-15T09:30:00Z"
286                   }
287                 }
288               ],
289               "replicate_states": {},
290               "partial_snapshot": {
291                 "ongoing_create_snapshot_requests": 1,
292                 "is_recovering": true,
293                 "recovery_timestamp": 1
294               }
295             }
296           ],
297           "transfers": [
298             {
299               "shard_id": 1,
300               "to_shard_id": 1,
301               "from": 1,
302               "to": 1,
303               "sync": true,
304               "method": "stream_records",
305               "comment": "string"
306             }
307           ],
308           "resharding": [
309             {
310               "direction": "up",
311               "shard_id": 1,
312               "peer_id": 1,
313               "shard_key": "region_1"
314             }
315           ],
316           "shard_clean_tasks": {}
317         }
318       ],
319       "snapshots": [
320         {
321           "id": "string",
322           "running_snapshots": 1,
323           "running_snapshot_recovery": 1,
324           "total_snapshot_creations": 1
325         }
326       ]
327     },
328     "app": {
329       "name": "string",
330       "version": "string",
331       "features": {
332         "debug": true,
333         "service_debug_feature": true,
334         "recovery_mode": true,
335         "gpu": true,
336         "rocksdb": true,
337         "staging": true
338       },
339       "runtime_features": {
340         "all": false,
341         "payload_index_skip_rocksdb": true,
342         "payload_index_skip_mutable_rocksdb": true,
343         "payload_storage_skip_rocksdb": true,
344         "incremental_hnsw_building": true,
345         "migrate_rocksdb_id_tracker": true,
346         "migrate_rocksdb_vector_storage": true,
347         "migrate_rocksdb_payload_storage": true,
348         "migrate_rocksdb_payload_indices": true,
349         "appendable_quantization": true,
350         "single_file_mmap_vector_storage": false
351       },
352       "hnsw_global_config": {
353         "healing_threshold": 0.3
354       },
355       "system": {
356         "distribution": "string",
357         "distribution_version": "string",
358         "is_docker": true,
359         "cores": 1,
360         "ram_size": 1,
361         "disk_size": 1,
362         "cpu_flags": "string",
363         "cpu_endian": "little",
364         "gpu_devices": [
365           {
366             "name": "string"
367           }
368         ]
369       },
370       "jwt_rbac": true,
371       "hide_jwt_dashboard": true,
372       "startup": "2024-01-15T09:30:00Z"
373     },
374     "cluster": {
375       "enabled": true,
376       "status": {
377         "number_of_peers": 1,
378         "term": 1,
379         "commit": 1,
380         "pending_operations": 1,
381         "role": "Follower",
382         "is_voter": true,
383         "peer_id": 1,
384         "consensus_thread_status": {
385           "consensus_thread_status": "working",
386           "last_update": "2024-01-15T09:30:00Z"
387         }
388       },
389       "config": {
390         "grpc_timeout_ms": 1,
391         "p2p": {
392           "connection_pool_size": 1
393         },
394         "consensus": {
395           "max_message_queue_size": 1,
396           "tick_period_ms": 1,
397           "bootstrap_timeout_sec": 1
398         }
399       },
400       "peers": {},
401       "peer_metadata": {},
402       "metadata": {},
403       "resharding_enabled": true
404     },
405     "requests": {
406       "rest": {
407         "responses": {}
408       },
409       "grpc": {
410         "responses": {}
411       }
412     },
413     "memory": {
414       "active_bytes": 1,
415       "allocated_bytes": 1,
416       "metadata_bytes": 1,
417       "resident_bytes": 1,
418       "retained_bytes": 1
419     },
420     "hardware": {
421       "collection_data": {}
422     }
423   }
424 }

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

details_levelintegerOptional>=0

Level of details in telemetry data. Minimal level is 0, maximal is infinity

timeoutintegerOptional>=1Defaults to 60

Timeout for this request

Response

successful operation

usageobject or any or null

timedouble or null

Time spent to process this request

statusstring or null

resultobject or null