Collect telemetry data

GET

/telemetry

GET

/telemetry

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

200Retrieved

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

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

Time spent to process this request

statusstring

resultobject