For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CloudGitHub
  • API Reference
      • GETCollect telemetry data
      • GETRetrieve instance details
      • GETCollect Prometheus metrics data
      • GETKubernetes health check
      • GETKubernetes liveness probe
      • GETKubernetes readiness probe
      • GETCheck write protection
      • POSTSet write protection
LogoLogo
CloudGitHub
API ReferenceService

Collect telemetry data

GET
/telemetry
GET
/telemetry
$curl http://localhost:6333/telemetry \
>     -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": 0.2,
50              "vacuum_min_vector_number": 1000,
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              "search_max_batchsize": 1,
82              "max_collection_vector_size_bytes": 1,
83              "read_rate_limit": 1,
84              "write_rate_limit": 1,
85              "max_collection_payload_size_bytes": 1,
86              "max_points_count": 1,
87              "filter_max_conditions": 1,
88              "condition_max_size": 1,
89              "multivector_config": {},
90              "sparse_config": {},
91              "max_payload_index_count": 1,
92              "max_resident_memory_percent": 1
93            },
94            "uuid": "string",
95            "metadata": {}
96          },
97          "shards": [
98            {
99              "id": 1,
100              "key": "region_1",
101              "local": {
102                "variant_name": "string",
103                "status": "green",
104                "total_optimized_points": 1,
105                "vectors_size_bytes": 1,
106                "payloads_size_bytes": 1,
107                "num_points": 1,
108                "num_vectors": 1,
109                "num_vectors_by_name": {},
110                "segments": [
111                  {
112                    "info": {
113                      "uuid": "string",
114                      "segment_type": "plain",
115                      "num_vectors": 1,
116                      "num_points": 1,
117                      "num_deferred_points": 1,
118                      "num_deleted_deferred_points": 1,
119                      "num_indexed_vectors": 1,
120                      "num_deleted_vectors": 1,
121                      "vectors_size_bytes": 1,
122                      "payloads_size_bytes": 1,
123                      "ram_usage_bytes": 1,
124                      "disk_usage_bytes": 1,
125                      "is_appendable": true,
126                      "index_schema": {},
127                      "vector_data": {},
128                      "deferred_internal_id": 1
129                    },
130                    "config": {
131                      "vector_data": {},
132                      "sparse_vector_data": {},
133                      "payload_storage_type": {
134                        "type": "mmap"
135                      }
136                    },
137                    "vector_index_searches": [
138                      {
139                        "index_name": "string",
140                        "unfiltered_plain": {
141                          "count": 1,
142                          "fail_count": 1,
143                          "avg_duration_micros": 1.1,
144                          "min_duration_micros": 1.1,
145                          "max_duration_micros": 1.1,
146                          "total_duration_micros": 1,
147                          "last_responded": "2024-01-15T09:30:00Z"
148                        },
149                        "unfiltered_hnsw": {
150                          "count": 1,
151                          "fail_count": 1,
152                          "avg_duration_micros": 1.1,
153                          "min_duration_micros": 1.1,
154                          "max_duration_micros": 1.1,
155                          "total_duration_micros": 1,
156                          "last_responded": "2024-01-15T09:30:00Z"
157                        },
158                        "unfiltered_sparse": {
159                          "count": 1,
160                          "fail_count": 1,
161                          "avg_duration_micros": 1.1,
162                          "min_duration_micros": 1.1,
163                          "max_duration_micros": 1.1,
164                          "total_duration_micros": 1,
165                          "last_responded": "2024-01-15T09:30:00Z"
166                        },
167                        "filtered_plain": {
168                          "count": 1,
169                          "fail_count": 1,
170                          "avg_duration_micros": 1.1,
171                          "min_duration_micros": 1.1,
172                          "max_duration_micros": 1.1,
173                          "total_duration_micros": 1,
174                          "last_responded": "2024-01-15T09:30:00Z"
175                        },
176                        "filtered_small_cardinality": {
177                          "count": 1,
178                          "fail_count": 1,
179                          "avg_duration_micros": 1.1,
180                          "min_duration_micros": 1.1,
181                          "max_duration_micros": 1.1,
182                          "total_duration_micros": 1,
183                          "last_responded": "2024-01-15T09:30:00Z"
184                        },
185                        "filtered_large_cardinality": {
186                          "count": 1,
187                          "fail_count": 1,
188                          "avg_duration_micros": 1.1,
189                          "min_duration_micros": 1.1,
190                          "max_duration_micros": 1.1,
191                          "total_duration_micros": 1,
192                          "last_responded": "2024-01-15T09:30:00Z"
193                        },
194                        "filtered_exact": {
195                          "count": 1,
196                          "fail_count": 1,
197                          "avg_duration_micros": 1.1,
198                          "min_duration_micros": 1.1,
199                          "max_duration_micros": 1.1,
200                          "total_duration_micros": 1,
201                          "last_responded": "2024-01-15T09:30:00Z"
202                        },
203                        "filtered_sparse": {
204                          "count": 1,
205                          "fail_count": 1,
206                          "avg_duration_micros": 1.1,
207                          "min_duration_micros": 1.1,
208                          "max_duration_micros": 1.1,
209                          "total_duration_micros": 1,
210                          "last_responded": "2024-01-15T09:30:00Z"
211                        },
212                        "unfiltered_exact": {
213                          "count": 1,
214                          "fail_count": 1,
215                          "avg_duration_micros": 1.1,
216                          "min_duration_micros": 1.1,
217                          "max_duration_micros": 1.1,
218                          "total_duration_micros": 1,
219                          "last_responded": "2024-01-15T09:30:00Z"
220                        }
221                      }
222                    ],
223                    "payload_field_indices": [
224                      {
225                        "field_name": "string",
226                        "index_type": "string",
227                        "points_values_count": 1,
228                        "points_count": 1,
229                        "histogram_bucket_size": 1
230                      }
231                    ]
232                  }
233                ],
234                "optimizations": {
235                  "status": "ok",
236                  "optimizations": {
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                  "log": [
246                    {
247                      "name": "string",
248                      "uuid": "string",
249                      "segment_ids": [
250                        1
251                      ],
252                      "segment_uuids": [
253                        "string"
254                      ],
255                      "status": {
256                        "cancelled": {}
257                      },
258                      "start_at": "2024-01-15T09:30:00Z",
259                      "end_at": "2024-01-15T09:30:00Z"
260                    }
261                  ]
262                },
263                "async_scorer": true,
264                "indexed_only_excluded_vectors": {},
265                "update_queue": {
266                  "length": 1,
267                  "op_num": 1,
268                  "deferred_points": 1
269                }
270              },
271              "remote": [
272                {
273                  "shard_id": 1,
274                  "peer_id": 1,
275                  "searches": {
276                    "count": 1,
277                    "fail_count": 1,
278                    "avg_duration_micros": 1.1,
279                    "min_duration_micros": 1.1,
280                    "max_duration_micros": 1.1,
281                    "total_duration_micros": 1,
282                    "last_responded": "2024-01-15T09:30:00Z"
283                  },
284                  "updates": {
285                    "count": 1,
286                    "fail_count": 1,
287                    "avg_duration_micros": 1.1,
288                    "min_duration_micros": 1.1,
289                    "max_duration_micros": 1.1,
290                    "total_duration_micros": 1,
291                    "last_responded": "2024-01-15T09:30:00Z"
292                  }
293                }
294              ],
295              "replicate_states": {},
296              "partial_snapshot": {
297                "ongoing_create_snapshot_requests": 1,
298                "is_recovering": true,
299                "recovery_timestamp": 1
300              }
301            }
302          ],
303          "transfers": [
304            {
305              "shard_id": 1,
306              "to_shard_id": 1,
307              "from": 1,
308              "to": 1,
309              "sync": true,
310              "method": "stream_records",
311              "comment": "string"
312            }
313          ],
314          "resharding": [
315            {
316              "direction": "up",
317              "shard_id": 1,
318              "peer_id": 1,
319              "shard_key": "region_1"
320            }
321          ],
322          "shard_clean_tasks": {}
323        }
324      ],
325      "snapshots": [
326        {
327          "id": "string",
328          "running_snapshots": 1,
329          "running_snapshot_recovery": 1,
330          "total_snapshot_creations": 1
331        }
332      ]
333    },
334    "app": {
335      "name": "string",
336      "version": "string",
337      "features": {
338        "debug": true,
339        "service_debug_feature": true,
340        "recovery_mode": true,
341        "gpu": true,
342        "rocksdb": true,
343        "staging": true
344      },
345      "runtime_features": {
346        "all": false,
347        "incremental_hnsw_building": true,
348        "appendable_quantization": true,
349        "single_file_mmap_vector_storage": false
350      },
351      "low_memory_mode": "disabled",
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        "cpu_cores_used": 1.1,
361        "ram_size": 1,
362        "disk_size": 1,
363        "cpu_flags": "string",
364        "cpu_endian": "little",
365        "gpu_devices": [
366          {
367            "name": "string"
368          }
369        ]
370      },
371      "jwt_rbac": true,
372      "hide_jwt_dashboard": true,
373      "audit": {
374        "dir": "string",
375        "rotation": "string",
376        "max_log_files": 1,
377        "trust_forwarded_headers": true,
378        "log_api": true,
379        "dir_size_bytes": 1
380      },
381      "startup": "2024-01-15T09:30:00Z"
382    },
383    "cluster": {
384      "enabled": true,
385      "status": {
386        "number_of_peers": 1,
387        "term": 1,
388        "commit": 1,
389        "pending_operations": 1,
390        "role": "Follower",
391        "is_voter": true,
392        "peer_id": 1,
393        "consensus_thread_status": {
394          "consensus_thread_status": "working",
395          "last_update": "2024-01-15T09:30:00Z"
396        }
397      },
398      "config": {
399        "grpc_timeout_ms": 1,
400        "p2p": {
401          "connection_pool_size": 1
402        },
403        "consensus": {
404          "max_message_queue_size": 1,
405          "tick_period_ms": 1,
406          "bootstrap_timeout_sec": 1
407        }
408      },
409      "peers": {},
410      "peer_metadata": {},
411      "metadata": {},
412      "resharding_enabled": true
413    },
414    "requests": {
415      "rest": {
416        "responses": {},
417        "per_collection_responses": {}
418      },
419      "grpc": {
420        "responses": {},
421        "per_collection_responses": {}
422      }
423    },
424    "memory": {
425      "active_bytes": 1,
426      "allocated_bytes": 1,
427      "metadata_bytes": 1,
428      "resident_bytes": 1,
429      "retained_bytes": 1
430    },
431    "hardware": {
432      "collection_data": {}
433    },
434    "search_pool": {
435      "mode": "string",
436      "high_cpu_threads": 1,
437      "high_io_threads": 1
438    }
439  }
440}

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

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
per_collectionbooleanOptional

If true, include per-collection request statistics in the response

timeoutintegerOptional>=1Defaults to 60
Timeout for this request

Response

successful operation
usageobject or any
timedouble
Time spent to process this request
statusstring
resultobject