LogoLogo
CloudGitHub
  • API Reference
CloudGitHub
API ReferenceService

GET
/telemetry
GET
/telemetry
1curl http://localhost:6333/telemetry \
2     -H "api-key: <apiKey>"
Try it
200Retrieved
1{
2  "usage": {
3    "cpu": 1,
4    "payload_io_read": 1,
5    "payload_io_write": 1,
6    "payload_index_io_read": 1,
7    "payload_index_io_write": 1,
8    "vector_io_read": 1,
9    "vector_io_write": 1
10  },
11  "time": 0.002,
12  "status": "ok",
13  "result": {
14    "id": "string",
15    "app": {
16      "name": "string",
17      "version": "string",
18      "startup": "2024-01-15T09:30:00Z",
19      "features": {
20        "debug": true,
21        "web_feature": true,
22        "service_debug_feature": true,
23        "recovery_mode": true,
24        "gpu": true
25      },
26      "system": {
27        "distribution": "string",
28        "distribution_version": "string",
29        "is_docker": true,
30        "cores": 1,
31        "ram_size": 1,
32        "disk_size": 1,
33        "cpu_flags": "string",
34        "cpu_endian": "little",
35        "gpu_devices": [
36          {
37            "name": "string"
38          }
39        ]
40      },
41      "jwt_rbac": true,
42      "hide_jwt_dashboard": true
43    },
44    "collections": {
45      "number_of_collections": 1,
46      "collections": [
47        {
48          "id": "string",
49          "init_time_ms": 1,
50          "config": {
51            "params": {
52              "vectors": {},
53              "shard_number": 1,
54              "sharding_method": "auto",
55              "replication_factor": 1,
56              "write_consistency_factor": 1,
57              "read_fan_out_factor": 1,
58              "on_disk_payload": true,
59              "sparse_vectors": {}
60            },
61            "hnsw_config": {
62              "m": 1,
63              "ef_construct": 1,
64              "full_scan_threshold": 1,
65              "max_indexing_threads": 0,
66              "on_disk": true,
67              "payload_m": 1
68            },
69            "optimizer_config": {
70              "deleted_threshold": 1.1,
71              "vacuum_min_vector_number": 1,
72              "default_segment_number": 1,
73              "max_segment_size": 1,
74              "memmap_threshold": 1,
75              "indexing_threshold": 1,
76              "flush_interval_sec": 1,
77              "max_optimization_threads": 1
78            },
79            "wal_config": {
80              "wal_capacity_mb": 1,
81              "wal_segments_ahead": 1
82            },
83            "quantization_config": {
84              "scalar": {
85                "type": "int8",
86                "quantile": 1.1,
87                "always_ram": true
88              }
89            },
90            "strict_mode_config": {
91              "enabled": true,
92              "max_query_limit": 1,
93              "max_timeout": 1,
94              "unindexed_filtering_retrieve": true,
95              "unindexed_filtering_update": true,
96              "search_max_hnsw_ef": 1,
97              "search_allow_exact": true,
98              "search_max_oversampling": 1.1,
99              "upsert_max_batchsize": 1,
100              "max_collection_vector_size_bytes": 1,
101              "read_rate_limit": 1,
102              "write_rate_limit": 1,
103              "max_collection_payload_size_bytes": 1,
104              "max_points_count": 1,
105              "filter_max_conditions": 1,
106              "condition_max_size": 1,
107              "multivector_config": {},
108              "sparse_config": {}
109            },
110            "uuid": "string"
111          },
112          "shards": [
113            {
114              "id": 1,
115              "key": "region_1",
116              "local": {
117                "variant_name": "string",
118                "status": "green",
119                "total_optimized_points": 1,
120                "vectors_size_bytes": 1,
121                "payloads_size_bytes": 1,
122                "num_points": 1,
123                "num_vectors": 1,
124                "segments": [
125                  {
126                    "info": {
127                      "segment_type": "plain",
128                      "num_vectors": 1,
129                      "num_points": 1,
130                      "num_indexed_vectors": 1,
131                      "num_deleted_vectors": 1,
132                      "vectors_size_bytes": 1,
133                      "payloads_size_bytes": 1,
134                      "ram_usage_bytes": 1,
135                      "disk_usage_bytes": 1,
136                      "is_appendable": true,
137                      "index_schema": {},
138                      "vector_data": {}
139                    },
140                    "config": {
141                      "vector_data": {},
142                      "sparse_vector_data": {},
143                      "payload_storage_type": {
144                        "type": "in_memory"
145                      }
146                    },
147                    "vector_index_searches": [
148                      {
149                        "index_name": "string",
150                        "unfiltered_plain": {
151                          "count": 1,
152                          "fail_count": 1,
153                          "avg_duration_micros": 1.1,
154                          "min_duration_micros": 1.1,
155                          "max_duration_micros": 1.1,
156                          "total_duration_micros": 1,
157                          "last_responded": "2024-01-15T09:30:00Z"
158                        },
159                        "unfiltered_hnsw": {
160                          "count": 1,
161                          "fail_count": 1,
162                          "avg_duration_micros": 1.1,
163                          "min_duration_micros": 1.1,
164                          "max_duration_micros": 1.1,
165                          "total_duration_micros": 1,
166                          "last_responded": "2024-01-15T09:30:00Z"
167                        },
168                        "unfiltered_sparse": {
169                          "count": 1,
170                          "fail_count": 1,
171                          "avg_duration_micros": 1.1,
172                          "min_duration_micros": 1.1,
173                          "max_duration_micros": 1.1,
174                          "total_duration_micros": 1,
175                          "last_responded": "2024-01-15T09:30:00Z"
176                        },
177                        "filtered_plain": {
178                          "count": 1,
179                          "fail_count": 1,
180                          "avg_duration_micros": 1.1,
181                          "min_duration_micros": 1.1,
182                          "max_duration_micros": 1.1,
183                          "total_duration_micros": 1,
184                          "last_responded": "2024-01-15T09:30:00Z"
185                        },
186                        "filtered_small_cardinality": {
187                          "count": 1,
188                          "fail_count": 1,
189                          "avg_duration_micros": 1.1,
190                          "min_duration_micros": 1.1,
191                          "max_duration_micros": 1.1,
192                          "total_duration_micros": 1,
193                          "last_responded": "2024-01-15T09:30:00Z"
194                        },
195                        "filtered_large_cardinality": {
196                          "count": 1,
197                          "fail_count": 1,
198                          "avg_duration_micros": 1.1,
199                          "min_duration_micros": 1.1,
200                          "max_duration_micros": 1.1,
201                          "total_duration_micros": 1,
202                          "last_responded": "2024-01-15T09:30:00Z"
203                        },
204                        "filtered_exact": {
205                          "count": 1,
206                          "fail_count": 1,
207                          "avg_duration_micros": 1.1,
208                          "min_duration_micros": 1.1,
209                          "max_duration_micros": 1.1,
210                          "total_duration_micros": 1,
211                          "last_responded": "2024-01-15T09:30:00Z"
212                        },
213                        "filtered_sparse": {
214                          "count": 1,
215                          "fail_count": 1,
216                          "avg_duration_micros": 1.1,
217                          "min_duration_micros": 1.1,
218                          "max_duration_micros": 1.1,
219                          "total_duration_micros": 1,
220                          "last_responded": "2024-01-15T09:30:00Z"
221                        },
222                        "unfiltered_exact": {
223                          "count": 1,
224                          "fail_count": 1,
225                          "avg_duration_micros": 1.1,
226                          "min_duration_micros": 1.1,
227                          "max_duration_micros": 1.1,
228                          "total_duration_micros": 1,
229                          "last_responded": "2024-01-15T09:30:00Z"
230                        }
231                      }
232                    ],
233                    "payload_field_indices": [
234                      {
235                        "field_name": "string",
236                        "index_type": "string",
237                        "points_values_count": 1,
238                        "points_count": 1,
239                        "histogram_bucket_size": 1
240                      }
241                    ]
242                  }
243                ],
244                "optimizations": {
245                  "status": "ok",
246                  "optimizations": {
247                    "count": 1,
248                    "fail_count": 1,
249                    "avg_duration_micros": 1.1,
250                    "min_duration_micros": 1.1,
251                    "max_duration_micros": 1.1,
252                    "total_duration_micros": 1,
253                    "last_responded": "2024-01-15T09:30:00Z"
254                  },
255                  "log": [
256                    {
257                      "name": "string",
258                      "segment_ids": [
259                        1
260                      ],
261                      "status": "optimizing",
262                      "start_at": "2024-01-15T09:30:00Z",
263                      "end_at": "2024-01-15T09:30:00Z"
264                    }
265                  ]
266                },
267                "async_scorer": true
268              },
269              "remote": [
270                {
271                  "shard_id": 1,
272                  "peer_id": 1,
273                  "searches": {
274                    "count": 1,
275                    "fail_count": 1,
276                    "avg_duration_micros": 1.1,
277                    "min_duration_micros": 1.1,
278                    "max_duration_micros": 1.1,
279                    "total_duration_micros": 1,
280                    "last_responded": "2024-01-15T09:30:00Z"
281                  },
282                  "updates": {
283                    "count": 1,
284                    "fail_count": 1,
285                    "avg_duration_micros": 1.1,
286                    "min_duration_micros": 1.1,
287                    "max_duration_micros": 1.1,
288                    "total_duration_micros": 1,
289                    "last_responded": "2024-01-15T09:30:00Z"
290                  }
291                }
292              ],
293              "replicate_states": {}
294            }
295          ],
296          "transfers": [
297            {
298              "shard_id": 1,
299              "to_shard_id": 1,
300              "from": 1,
301              "to": 1,
302              "sync": true,
303              "method": "stream_records",
304              "comment": "string"
305            }
306          ],
307          "resharding": [
308            {
309              "direction": "up",
310              "shard_id": 1,
311              "peer_id": 1,
312              "shard_key": "region_1"
313            }
314          ],
315          "shard_clean_tasks": {}
316        }
317      ]
318    },
319    "cluster": {
320      "enabled": true,
321      "status": {
322        "number_of_peers": 1,
323        "term": 1,
324        "commit": 1,
325        "pending_operations": 1,
326        "role": "Follower",
327        "is_voter": true,
328        "peer_id": 1,
329        "consensus_thread_status": {
330          "consensus_thread_status": "working",
331          "last_update": "2024-01-15T09:30:00Z"
332        }
333      },
334      "config": {
335        "grpc_timeout_ms": 1,
336        "p2p": {
337          "connection_pool_size": 1
338        },
339        "consensus": {
340          "max_message_queue_size": 1,
341          "tick_period_ms": 1,
342          "bootstrap_timeout_sec": 1
343        }
344      },
345      "peers": {},
346      "metadata": {}
347    },
348    "requests": {
349      "rest": {
350        "responses": {}
351      },
352      "grpc": {
353        "responses": {}
354      }
355    },
356    "memory": {
357      "active_bytes": 1,
358      "allocated_bytes": 1,
359      "metadata_bytes": 1,
360      "resident_bytes": 1,
361      "retained_bytes": 1
362    },
363    "hardware": {
364      "collection_data": {}
365    }
366  }
367}
Collects telemetry data, such as: application info, system info, collection info, cluster info, configs and statistics.
Was this page helpful?
Previous

Retrieve instance details

Next
Built with

Headers

api-keystringRequired

Query parameters

anonymizebooleanOptional
If true, anonymize result
details_levelintegerOptional>=0
Level of details in telemetry data. Minimal level is 0, maximal is infinity

Response

successful operation
usageobject or any or null
timedouble or null
Time spent to process this request
statusstring or null
resultobject or null
Collect telemetry data
Retrieve instance details

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