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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2021 Nordix Foundation.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.policy.clamp.controlloop.runtime.main.rest;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import io.swagger.annotations.Authorization;
import io.swagger.annotations.Extension;
import io.swagger.annotations.ExtensionProperty;
import io.swagger.annotations.ResponseHeader;
import java.time.Instant;
import java.util.UUID;
import lombok.RequiredArgsConstructor;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ClElementStatisticsList;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantStatisticsList;
import org.onap.policy.clamp.controlloop.runtime.main.web.AbstractRestController;
import org.onap.policy.clamp.controlloop.runtime.monitoring.MonitoringProvider;
import org.onap.policy.models.base.PfModelException;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
/**
* This class handles REST endpoints for CL Statistics monitoring.
*/
@RestController
@RequiredArgsConstructor
public class MonitoringQueryController extends AbstractRestController {
private static final String TAGS = "Clamp Control Loop Monitoring API";
private final MonitoringProvider provider;
/**
* Queries details of control loop participants statistics.
*
* @param requestId request ID used in ONAP logging
* @param name the name of the participant to get, null for all participants statistics
* @param version the version of the participant to get, null for all participants with the given name
* @param recordCount the record count to be fetched
* @param startTime the time from which to get statistics
* @param endTime the time to which to get statistics
* @return the participant statistics
*/
// @formatter:off
@GetMapping(value = "/monitoring/participant",
produces = {MediaType.APPLICATION_JSON_VALUE, APPLICATION_YAML})
@ApiOperation(value = "Query details of the requested participant stats",
notes = "Queries details of the requested participant stats, returning all participant stats",
response = ParticipantStatisticsList.class,
tags = {TAGS},
authorizations = @Authorization(value = AUTHORIZATION_TYPE),
responseHeaders = {
@ResponseHeader(
name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
response = String.class),
@ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
response = String.class),
@ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
response = String.class),
@ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
response = UUID.class)},
extensions = {
@Extension
(
name = EXTENSION_NAME,
properties = {
@ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
@ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
}
)
}
)
@ApiResponses(
value = {
@ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
@ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
@ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
}
)
// @formatter:on
public ResponseEntity<ParticipantStatisticsList> queryParticipantStatistics(
@RequestHeader(
name = REQUEST_ID_NAME,
required = false) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
@ApiParam(value = "Control Loop participant name") @RequestParam(
value = "name",
required = false) final String name,
@ApiParam(value = "Control Loop participant version", required = false) @RequestParam(
value = "version",
required = false) final String version,
@ApiParam(value = "Record count", required = false) @RequestParam(
value = "recordCount",
required = false,
defaultValue = "0") final int recordCount,
@ApiParam(value = "start time", required = false) @RequestParam(
value = "startTime",
required = false) final String startTime,
@ApiParam(value = "end time", required = false) @RequestParam(
value = "endTime",
required = false) final String endTime) {
Instant startTimestamp = null;
Instant endTimestamp = null;
if (startTime != null) {
startTimestamp = Instant.parse(startTime);
}
if (endTime != null) {
endTimestamp = Instant.parse(endTime);
}
return ResponseEntity.ok().body(
provider.fetchFilteredParticipantStatistics(name, version, recordCount, startTimestamp, endTimestamp));
}
/**
* Queries details of all participant statistics per control loop.
*
* @param requestId request ID used in ONAP logging
* @param name the name of the control loop
* @param version version of the control loop
* @return the control loop element statistics
*/
// @formatter:off
@GetMapping(value = "/monitoring/participants/controlloop",
produces = {MediaType.APPLICATION_JSON_VALUE, APPLICATION_YAML})
@ApiOperation(value = "Query details of all the participant stats in a control loop",
notes = "Queries details of the participant stats, returning all participant stats",
response = ClElementStatisticsList.class,
tags = {TAGS},
authorizations = @Authorization(value = AUTHORIZATION_TYPE),
responseHeaders = {
@ResponseHeader(
name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
response = String.class),
@ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
response = String.class),
@ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
response = String.class),
@ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
response = UUID.class)},
extensions = {
@Extension
(
name = EXTENSION_NAME,
properties = {
@ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
@ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
}
)
})
@ApiResponses(
value = {
@ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
@ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
@ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
}
)
// @formatter:on
public ResponseEntity<ParticipantStatisticsList> queryParticipantStatisticsPerControlLoop(
@RequestHeader(
name = REQUEST_ID_NAME,
required = false) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
@ApiParam(value = "Control Loop name", required = true) @RequestParam(
value = "name",
required = false) final String name,
@ApiParam(value = "Control Loop version", required = true) @RequestParam(
value = "version",
required = false) final String version) {
return ResponseEntity.ok().body(provider.fetchParticipantStatsPerControlLoop(name, version));
}
/**
* Queries details of all control loop element statistics per control loop.
*
* @param requestId request ID used in ONAP logging
* @param name the name of the control loop
* @param version version of the control loop
* @return the control loop element statistics
*/
// @formatter:off
@GetMapping(value = "/monitoring/clelements/controlloop",
produces = {MediaType.APPLICATION_JSON_VALUE, APPLICATION_YAML})
@ApiOperation(value = "Query details of the requested cl element stats in a control loop",
notes = "Queries details of the requested cl element stats, returning all clElement stats",
response = ClElementStatisticsList.class,
tags = {TAGS},
authorizations = @Authorization(value = AUTHORIZATION_TYPE),
responseHeaders = {
@ResponseHeader(
name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
response = String.class),
@ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
response = String.class),
@ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
response = String.class),
@ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
response = UUID.class)},
extensions = {
@Extension
(
name = EXTENSION_NAME,
properties = {
@ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
@ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
}
)
})
@ApiResponses(
value = {
@ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
@ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
@ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
}
)
// @formatter:on
public ResponseEntity<ClElementStatisticsList> queryElementStatisticsPerControlLoop(
@RequestHeader(
name = REQUEST_ID_NAME,
required = false) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
@ApiParam(value = "Control Loop name", required = true) @RequestParam(
value = "name",
required = false) final String name,
@ApiParam(value = "Control Loop version", required = true) @RequestParam(
value = "version",
required = false) final String version) {
return ResponseEntity.ok().body(provider.fetchClElementStatsPerControlLoop(name, version));
}
/**
* Queries details of all control loop element statistics per control loop.
*
* @param requestId request ID used in ONAP logging
* @param name the name of the control loop
* @param version version of the control loop
* @param id Id of the control loop element
* @param recordCount the record count to be fetched
* @param startTime the time from which to get statistics
* @param endTime the time to which to get statistics
* @return the control loop element statistics
* @throws PfModelException on errors getting details of all control loop element statistics per control loop
*/
// @formatter:off
@GetMapping(value = "/monitoring/clelement",
produces = {MediaType.APPLICATION_JSON_VALUE, APPLICATION_YAML})
@ApiOperation(value = "Query details of the requested cl element stats",
notes = "Queries details of the requested cl element stats, returning all clElement stats",
response = ClElementStatisticsList.class,
tags = {TAGS},
authorizations = @Authorization(value = AUTHORIZATION_TYPE),
responseHeaders = {
@ResponseHeader(
name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION,
response = String.class),
@ResponseHeader(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION,
response = String.class),
@ResponseHeader(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION,
response = String.class),
@ResponseHeader(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION,
response = UUID.class)},
extensions = {
@Extension
(
name = EXTENSION_NAME,
properties = {
@ExtensionProperty(name = API_VERSION_NAME, value = API_VERSION),
@ExtensionProperty(name = LAST_MOD_NAME, value = LAST_MOD_RELEASE)
}
)
})
@ApiResponses(
value = {
@ApiResponse(code = AUTHENTICATION_ERROR_CODE, message = AUTHENTICATION_ERROR_MESSAGE),
@ApiResponse(code = AUTHORIZATION_ERROR_CODE, message = AUTHORIZATION_ERROR_MESSAGE),
@ApiResponse(code = SERVER_ERROR_CODE, message = SERVER_ERROR_MESSAGE)
}
)
// @formatter:on
public ResponseEntity<ClElementStatisticsList> queryElementStatistics(
@RequestHeader(
name = REQUEST_ID_NAME,
required = false) @ApiParam(REQUEST_ID_PARAM_DESCRIPTION) UUID requestId,
@ApiParam(value = "Participant name", required = true) @RequestParam(
value = "name",
required = false) final String name,
@ApiParam(value = "Participant version", required = true) @RequestParam(
value = "version",
required = false) final String version,
@ApiParam(value = "Record count", required = false) @RequestParam(
value = "recordCount",
required = false,
defaultValue = "0") final int recordCount,
@ApiParam(value = "Control Loop element id", required = false) @RequestParam(
value = "id",
required = false) final String id,
@ApiParam(value = "start time", required = false) @RequestParam(
value = "startTime",
required = false) final String startTime,
@ApiParam(value = "end time", required = false) @RequestParam(
value = "endTime",
required = false) final String endTime)
throws PfModelException {
Instant startTimestamp = null;
Instant endTimestamp = null;
if (startTime != null) {
startTimestamp = Instant.parse(startTime);
}
if (endTime != null) {
endTimestamp = Instant.parse(endTime);
}
return ResponseEntity.ok().body(provider.fetchFilteredClElementStatistics(name, version, id, startTimestamp,
endTimestamp, recordCount));
}
}
|
