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

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

Response

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