Collect telemetry data

GET

http://localhost:6333/telemetry

GET

/telemetry

1 curl 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": "id",
15     "app": {
16       "name": "name",
17       "version": "version",
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         "is_docker": true,
28         "cpu_flags": "cpu_flags"
29       },
30       "jwt_rbac": true,
31       "hide_jwt_dashboard": true
32     },
33     "collections": {
34       "number_of_collections": 1,
35       "collections": [
36         {
37           "id": "id",
38           "init_time_ms": 1000000,
39           "config": {
40             "params": {},
41             "hnsw_config": {
42               "m": 1,
43               "ef_construct": 1,
44               "full_scan_threshold": 1
45             },
46             "optimizer_config": {
47               "deleted_threshold": 1.1,
48               "vacuum_min_vector_number": 1,
49               "default_segment_number": 1,
50               "flush_interval_sec": 1000000
51             },
52             "wal_config": {
53               "wal_capacity_mb": 1,
54               "wal_segments_ahead": 1
55             }
56           },
57           "shards": [
58             {
59               "id": 1,
60               "key": "region_1",
61               "remote": [
62                 {
63                   "shard_id": 1,
64                   "searches": {
65                     "count": 1,
66                     "total_duration_micros": 1000000
67                   },
68                   "updates": {
69                     "count": 1,
70                     "total_duration_micros": 1000000
71                   }
72                 }
73               ],
74               "replicate_states": {
75                 "key": "Active"
76               }
77             }
78           ],
79           "transfers": [
80             {
81               "shard_id": 1,
82               "from": 1000000,
83               "to": 1000000,
84               "sync": true
85             }
86           ],
87           "resharding": [
88             {
89               "direction": "up",
90               "shard_id": 1,
91               "peer_id": 1000000,
92               "shard_key": "region_1"
93             }
94           ],
95           "shard_clean_tasks": {
96             "key": "started"
97           }
98         }
99       ]
100     },
101     "cluster": {
102       "enabled": true,
103       "status": {
104         "number_of_peers": 1,
105         "term": 1000000,
106         "commit": 1000000,
107         "pending_operations": 1,
108         "is_voter": true,
109         "consensus_thread_status": {
110           "last_update": "2024-01-15T09:30:00Z",
111           "consensus_thread_status": "working"
112         }
113       },
114       "config": {
115         "grpc_timeout_ms": 1000000,
116         "p2p": {
117           "connection_pool_size": 1
118         },
119         "consensus": {
120           "max_message_queue_size": 1,
121           "tick_period_ms": 1000000,
122           "bootstrap_timeout_sec": 1000000
123         }
124       },
125       "metadata": {
126         "key": "value"
127       }
128     },
129     "requests": {
130       "rest": {
131         "responses": {
132           "key": {
133             "key": {
134               "count": 1,
135               "total_duration_micros": 1000000
136             }
137           }
138         }
139       },
140       "grpc": {
141         "responses": {
142           "key": {
143             "count": 1,
144             "total_duration_micros": 1000000
145           }
146         }
147       }
148     },
149     "memory": {
150       "active_bytes": 1,
151       "allocated_bytes": 1,
152       "metadata_bytes": 1,
153       "resident_bytes": 1,
154       "retained_bytes": 1
155     },
156     "hardware": {
157       "collection_data": {
158         "key": {
159           "cpu": 1,
160           "payload_io_read": 1,
161           "payload_io_write": 1,
162           "payload_index_io_read": 1,
163           "payload_index_io_write": 1,
164           "vector_io_read": 1,
165           "vector_io_write": 1
166         }
167       }
168     }
169   }
170 }

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

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 anyOptional

timedoubleOptional

Time spent to process this request

statusstringOptional

resultobjectOptional

Headers

Query parameters

Response