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

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