-
Notifications
You must be signed in to change notification settings - Fork 39
/
oximeter.json
279 lines (279 loc) · 7.05 KB
/
oximeter.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
{
"openapi": "3.0.3",
"info": {
"title": "Oxide Oximeter API",
"description": "API for interacting with oximeter",
"contact": {
"url": "https://oxide.computer",
"email": "[email protected]"
},
"version": "0.0.1"
},
"paths": {
"/info": {
"get": {
"summary": "Return identifying information about this collector.",
"operationId": "collector_info",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CollectorInfo"
}
}
}
},
"4XX": {
"$ref": "#/components/responses/Error"
},
"5XX": {
"$ref": "#/components/responses/Error"
}
}
}
},
"/producers": {
"get": {
"summary": "List all producers.",
"operationId": "producers_list",
"parameters": [
{
"in": "query",
"name": "limit",
"description": "Maximum number of items returned by a single call",
"schema": {
"nullable": true,
"type": "integer",
"format": "uint32",
"minimum": 1
}
},
{
"in": "query",
"name": "page_token",
"description": "Token returned by previous call to retrieve the subsequent page",
"schema": {
"nullable": true,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProducerEndpointResultsPage"
}
}
}
},
"4XX": {
"$ref": "#/components/responses/Error"
},
"5XX": {
"$ref": "#/components/responses/Error"
}
},
"x-dropshot-pagination": {
"required": []
}
}
},
"/producers/{producer_id}": {
"delete": {
"summary": "Delete a producer by ID.",
"operationId": "producer_delete",
"parameters": [
{
"in": "path",
"name": "producer_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "successful deletion"
},
"4XX": {
"$ref": "#/components/responses/Error"
},
"5XX": {
"$ref": "#/components/responses/Error"
}
}
}
}
},
"components": {
"schemas": {
"CollectorInfo": {
"type": "object",
"properties": {
"id": {
"description": "The collector's UUID.",
"type": "string",
"format": "uuid"
},
"last_refresh": {
"nullable": true,
"description": "Last time we refreshed our producer list with Nexus.",
"type": "string",
"format": "date-time"
}
},
"required": [
"id"
]
},
"Duration": {
"type": "object",
"properties": {
"nanos": {
"type": "integer",
"format": "uint32",
"minimum": 0
},
"secs": {
"type": "integer",
"format": "uint64",
"minimum": 0
}
},
"required": [
"nanos",
"secs"
]
},
"Error": {
"description": "Error information from a response.",
"type": "object",
"properties": {
"error_code": {
"type": "string"
},
"message": {
"type": "string"
},
"request_id": {
"type": "string"
}
},
"required": [
"message",
"request_id"
]
},
"ProducerEndpoint": {
"description": "Information announced by a metric server, used so that clients can contact it and collect available metric data from it.",
"type": "object",
"properties": {
"address": {
"description": "The IP address and port at which `oximeter` can collect metrics from the producer.",
"type": "string"
},
"id": {
"description": "A unique ID for this producer.",
"type": "string",
"format": "uuid"
},
"interval": {
"description": "The interval on which `oximeter` should collect metrics.",
"allOf": [
{
"$ref": "#/components/schemas/Duration"
}
]
},
"kind": {
"description": "The kind of producer.",
"allOf": [
{
"$ref": "#/components/schemas/ProducerKind"
}
]
}
},
"required": [
"address",
"id",
"interval",
"kind"
]
},
"ProducerEndpointResultsPage": {
"description": "A single page of results",
"type": "object",
"properties": {
"items": {
"description": "list of items on this page of results",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProducerEndpoint"
}
},
"next_page": {
"nullable": true,
"description": "token used to fetch the next page of results (if any)",
"type": "string"
}
},
"required": [
"items"
]
},
"ProducerKind": {
"description": "The kind of metric producer this is.",
"oneOf": [
{
"description": "The producer is a sled-agent.",
"type": "string",
"enum": [
"sled_agent"
]
},
{
"description": "The producer is an Omicron-managed service.",
"type": "string",
"enum": [
"service"
]
},
{
"description": "The producer is a Propolis VMM managing a guest instance.",
"type": "string",
"enum": [
"instance"
]
},
{
"description": "The producer is a management gateway service.",
"type": "string",
"enum": [
"management_gateway"
]
}
]
}
},
"responses": {
"Error": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
}