Collect telemetry data

GET

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

Play

200Retrieved

1 {
2   "time": 1.1,
3   "status": "status",
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     },
22     "collections": {
23       "number_of_collections": 1,
24       "collections": [
25         {
26           "id": "id",
27           "init_time_ms": 1,
28           "config": {
29             "params": {},
30             "hnsw_config": {
31               "m": 1,
32               "ef_construct": 1,
33               "full_scan_threshold": 1
34             },
35             "optimizer_config": {
36               "deleted_threshold": 1.1,
37               "vacuum_min_vector_number": 1,
38               "default_segment_number": 1,
39               "flush_interval_sec": 1
40             },
41             "wal_config": {
42               "wal_capacity_mb": 1,
43               "wal_segments_ahead": 1
44             }
45           },
46           "shards": [
47             {
48               "id": 1,
49               "remote": [
50                 {
51                   "shard_id": 1,
52                   "searches": {
53                     "count": 1,
54                     "total_duration_micros": 1
55                   },
56                   "updates": {
57                     "count": 1,
58                     "total_duration_micros": 1
59                   }
60                 }
61               ],
62               "replicate_states": {
63                 "replicate_states": "Active"
64               }
65             }
66           ],
67           "transfers": [
68             {
69               "shard_id": 1,
70               "from": 1,
71               "to": 1,
72               "sync": true
73             }
74           ]
75         }
76       ]
77     },
78     "cluster": {
79       "enabled": true,
80       "status": {
81         "number_of_peers": 1,
82         "term": 1,
83         "commit": 1,
84         "pending_operations": 1,
85         "is_voter": true,
86         "consensus_thread_status": {
87           "consensus_thread_status": "working",
88           "last_update": "2024-01-15T09:30:00Z"
89         }
90       },
91       "config": {
92         "grpc_timeout_ms": 1,
93         "p2p": {
94           "connection_pool_size": 1
95         },
96         "consensus": {
97           "max_message_queue_size": 1,
98           "tick_period_ms": 1,
99           "bootstrap_timeout_sec": 1
100         }
101       }
102     },
103     "requests": {
104       "rest": {
105         "responses": {
106           "responses": {
107             "responses": {
108               "count": 1,
109               "total_duration_micros": 1
110             }
111           }
112         }
113       },
114       "grpc": {
115         "responses": {
116           "responses": {
117             "count": 1,
118             "total_duration_micros": 1
119           }
120         }
121       }
122     }
123   }
124 }

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

Query parameters

anonymizebooleanOptional

If true, anonymize result

Response

This endpoint returns an object.

timedoubleOptional

Time spent to process this request

statusstringOptional

resultobjectOptional

Headers

Query parameters

Response