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

Response

successful operation

timedoubleOptional

Time spent to process this request

statusstringOptional

resultobjectOptional

GET

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

200Retrieved

1 {
2   "time": 0.002,
3   "status": "ok",
4   "result": {
5     "id": "id",
6     "app": {
7       "name": "name",
8       "version": "version",
9       "startup": "2024-01-15T09:30:00Z",
10       "features": {
11         "debug": true,
12         "web_feature": true,
13         "service_debug_feature": true,
14         "recovery_mode": true
15       },
16       "system": {
17         "is_docker": true,
18         "cpu_flags": "cpu_flags"
19       },
20       "jwt_rbac": true,
21       "hide_jwt_dashboard": true
22     },
23     "collections": {
24       "number_of_collections": 1,
25       "collections": [
26         {
27           "id": "id",
28           "init_time_ms": 1000000,
29           "config": {
30             "params": {},
31             "hnsw_config": {
32               "m": 1,
33               "ef_construct": 1,
34               "full_scan_threshold": 1
35             },
36             "optimizer_config": {
37               "deleted_threshold": 1.1,
38               "vacuum_min_vector_number": 1,
39               "default_segment_number": 1,
40               "flush_interval_sec": 1000000
41             },
42             "wal_config": {
43               "wal_capacity_mb": 1,
44               "wal_segments_ahead": 1
45             }
46           },
47           "shards": [
48             {
49               "id": 1,
50               "remote": [
51                 {
52                   "shard_id": 1,
53                   "searches": {
54                     "count": 1,
55                     "total_duration_micros": 1000000
56                   },
57                   "updates": {
58                     "count": 1,
59                     "total_duration_micros": 1000000
60                   }
61                 }
62               ],
63               "replicate_states": {
64                 "key": "Active"
65               }
66             }
67           ],
68           "transfers": [
69             {
70               "shard_id": 1,
71               "from": 1000000,
72               "to": 1000000,
73               "sync": true
74             }
75           ],
76           "resharding": [
77             {
78               "direction": "up",
79               "shard_id": 1,
80               "peer_id": 1000000,
81               "shard_key": "region_1"
82             }
83           ]
84         }
85       ]
86     },
87     "cluster": {
88       "enabled": true,
89       "status": {
90         "number_of_peers": 1,
91         "term": 1000000,
92         "commit": 1000000,
93         "pending_operations": 1,
94         "is_voter": true,
95         "consensus_thread_status": {
96           "consensus_thread_status": "stopped_with_err",
97           "err": "consensus_thread_status"
98         }
99       },
100       "config": {
101         "grpc_timeout_ms": 1000000,
102         "p2p": {
103           "connection_pool_size": 1
104         },
105         "consensus": {
106           "max_message_queue_size": 1,
107           "tick_period_ms": 1000000,
108           "bootstrap_timeout_sec": 1000000
109         }
110       },
111       "metadata": {
112         "key": "value"
113       }
114     },
115     "requests": {
116       "rest": {
117         "responses": {
118           "key": {
119             "key": {
120               "count": 1,
121               "total_duration_micros": 1000000
122             }
123           }
124         }
125       },
126       "grpc": {
127         "responses": {
128           "key": {
129             "count": 1,
130             "total_duration_micros": 1000000
131           }
132         }
133       }
134     }
135   }
136 }

Retrieve instance details

Up Next

Built with

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

1	{
2	"time": 0.002,
3	"status": "ok",
4	"result": {
5	"id": "id",
6	"app": {
7	"name": "name",
8	"version": "version",
9	"startup": "2024-01-15T09:30:00Z",
10	"features": {
11	"debug": true,
12	"web_feature": true,
13	"service_debug_feature": true,
14	"recovery_mode": true
15	},
16	"system": {
17	"is_docker": true,
18	"cpu_flags": "cpu_flags"
19	},
20	"jwt_rbac": true,
21	"hide_jwt_dashboard": true
22	},
23	"collections": {
24	"number_of_collections": 1,
25	"collections": [
26	{
27	"id": "id",
28	"init_time_ms": 1000000,
29	"config": {
30	"params": {},
31	"hnsw_config": {
32	"m": 1,
33	"ef_construct": 1,
34	"full_scan_threshold": 1
35	},
36	"optimizer_config": {
37	"deleted_threshold": 1.1,
38	"vacuum_min_vector_number": 1,
39	"default_segment_number": 1,
40	"flush_interval_sec": 1000000
41	},
42	"wal_config": {
43	"wal_capacity_mb": 1,
44	"wal_segments_ahead": 1
45	}
46	},
47	"shards": [
48	{
49	"id": 1,
50	"remote": [
51	{
52	"shard_id": 1,
53	"searches": {
54	"count": 1,
55	"total_duration_micros": 1000000
56	},
57	"updates": {
58	"count": 1,
59	"total_duration_micros": 1000000
60	}
61	}
62	],
63	"replicate_states": {
64	"key": "Active"
65	}
66	}
67	],
68	"transfers": [
69	{
70	"shard_id": 1,
71	"from": 1000000,
72	"to": 1000000,
73	"sync": true
74	}
75	],
76	"resharding": [
77	{
78	"direction": "up",
79	"shard_id": 1,
80	"peer_id": 1000000,
81	"shard_key": "region_1"
82	}
83	]
84	}
85	]
86	},
87	"cluster": {
88	"enabled": true,
89	"status": {
90	"number_of_peers": 1,
91	"term": 1000000,
92	"commit": 1000000,
93	"pending_operations": 1,
94	"is_voter": true,
95	"consensus_thread_status": {
96	"consensus_thread_status": "stopped_with_err",
97	"err": "consensus_thread_status"
98	}
99	},
100	"config": {
101	"grpc_timeout_ms": 1000000,
102	"p2p": {
103	"connection_pool_size": 1
104	},
105	"consensus": {
106	"max_message_queue_size": 1,
107	"tick_period_ms": 1000000,
108	"bootstrap_timeout_sec": 1000000
109	}
110	},
111	"metadata": {
112	"key": "value"
113	}
114	},
115	"requests": {
116	"rest": {
117	"responses": {
118	"key": {
119	"key": {
120	"count": 1,
121	"total_duration_micros": 1000000
122	}
123	}
124	}
125	},
126	"grpc": {
127	"responses": {
128	"key": {
129	"count": 1,
130	"total_duration_micros": 1000000
131	}
132	}
133	}
134	}
135	}
136	}