Collect telemetry data

GET

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

Level of details in telemetry data. Minimal level is 0, maximal is infinity

Response

This endpoint returns an object.

usageobject or anyOptional

timedoubleOptional

Time spent to process this request

statusstringOptional

resultobjectOptional

GET

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

Retrieve instance details

Up Next

Built with

1	curl http://localhost:6333/telemetry \
2	-H "api-key: <apiKey>"

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