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
|
/*-
* ============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.monitoring;
import java.io.Closeable;
import java.io.IOException;
import java.time.Instant;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import lombok.NonNull;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ClElementStatistics;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ClElementStatisticsList;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoop;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ControlLoopElement;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantStatistics;
import org.onap.policy.clamp.controlloop.models.controlloop.concepts.ParticipantStatisticsList;
import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ClElementStatisticsProvider;
import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ControlLoopProvider;
import org.onap.policy.clamp.controlloop.models.controlloop.persistence.provider.ParticipantStatisticsProvider;
import org.onap.policy.models.base.PfModelException;
import org.onap.policy.models.base.PfModelRuntimeException;
import org.onap.policy.models.provider.PolicyModelsProviderParameters;
import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
/**
* This class provides information about statistics data of CL elements and CL Participants in database to callers.
*/
public class MonitoringProvider implements Closeable {
private static final String DESC_ORDER = "DESC";
private final ParticipantStatisticsProvider participantStatisticsProvider;
private final ClElementStatisticsProvider clElementStatisticsProvider;
private final ControlLoopProvider controlLoopProvider;
/**
* Create a Monitoring provider.
*
*/
public MonitoringProvider(PolicyModelsProviderParameters parameters) {
try {
participantStatisticsProvider = new ParticipantStatisticsProvider(parameters);
clElementStatisticsProvider = new ClElementStatisticsProvider(parameters);
controlLoopProvider = new ControlLoopProvider(parameters);
} catch (PfModelException e) {
throw new PfModelRuntimeException(e);
}
}
@Override
public void close() throws IOException {
controlLoopProvider.close();
clElementStatisticsProvider.close();
participantStatisticsProvider.close();
}
/**
* Create participant statistics.
*
* @param participantStatistics the participant statistics
* @return the result of create operation
* @throws PfModelException on creation errors
*/
public ParticipantStatisticsList createParticipantStatistics(List<ParticipantStatistics> participantStatistics)
throws PfModelException {
ParticipantStatisticsList participantStatisticsList = new ParticipantStatisticsList();
participantStatisticsList.setStatisticsList(participantStatisticsProvider
.createParticipantStatistics(participantStatistics));
return participantStatisticsList;
}
/**
* Create clElement statistics.
*
* @param clElementStatisticsList the clElement statistics
* @return the result of create operation
* @throws PfModelException on creation errors
*/
public ClElementStatisticsList createClElementStatistics(List<ClElementStatistics> clElementStatisticsList)
throws PfModelException {
ClElementStatisticsList elementStatisticsList = new ClElementStatisticsList();
elementStatisticsList.setClElementStatistics(clElementStatisticsProvider
.createClElementStatistics(clElementStatisticsList));
return elementStatisticsList;
}
/**
* Get participant statistics based on specific filters.
*
* @param name the name of the participant statistics to get, null to get all statistics
* @param version the version of the participant statistics to get, null to get all statistics
* @param recordCount number of records to be fetched.
* @param startTime start of the timestamp, from statistics to be filtered
* @param endTime end of the timestamp up to which statistics to be filtered
* @return the participant found
*/
public ParticipantStatisticsList fetchFilteredParticipantStatistics(@NonNull final String name,
final String version, int recordCount,
Instant startTime, Instant endTime) {
ParticipantStatisticsList participantStatisticsList = new ParticipantStatisticsList();
//Additional parameters can be added in filterMap for filtering data.
Map<String, Object> filterMap = null;
participantStatisticsList.setStatisticsList(participantStatisticsProvider.getFilteredParticipantStatistics(
name, version, startTime, endTime, filterMap, DESC_ORDER, recordCount));
return participantStatisticsList;
}
/**
* Get all participant statistics records found for a specific control loop. *
*
* @param controlLoopName name of the control loop
* @param controlLoopVersion version of the control loop
* @return All the participant statistics found
* @throws PfModelException on errors getting participant statistics
*/
public ParticipantStatisticsList fetchParticipantStatsPerControlLoop(@NonNull final String controlLoopName,
@NonNull final String controlLoopVersion)
throws PfModelException {
ParticipantStatisticsList statisticsList = new ParticipantStatisticsList();
List<ParticipantStatistics> participantStatistics = new ArrayList<>();
try {
//Fetch all participantIds for a specific control loop
List<ToscaConceptIdentifier> participantIds = getAllParticipantIdsPerControlLoop(controlLoopName,
controlLoopVersion);
for (ToscaConceptIdentifier id: participantIds) {
participantStatistics.addAll(participantStatisticsProvider.getFilteredParticipantStatistics(
id.getName(), id.getVersion(), null, null, null, DESC_ORDER, 0));
}
statisticsList.setStatisticsList(participantStatistics);
} catch (PfModelException e) {
throw new PfModelRuntimeException(e);
}
return statisticsList;
}
/**
* Get clElement statistics based on specific filters.
*
* @param name the name of the clElement statistics to get, null to get all statistics
* @param version the version of the clElement statistics to get, null to get all statistics
* @param id UUID of the control loop element
* @param startTime start of the timestamp, from statistics to be filtered
* @param endTime end of the timestamp up to which statistics to be filtered
* @param recordCount number of records to be fetched.
* @return the participant found
* @throws PfModelException on errors getting control loop statistics
*/
public ClElementStatisticsList fetchFilteredClElementStatistics(@NonNull final String name, final String version,
final String id, Instant startTime, Instant endTime,
int recordCount) throws PfModelException {
ClElementStatisticsList clElementStatisticsList = new ClElementStatisticsList();
Map<String, Object> filterMap = new HashMap<>();
//Adding UUID in filter if present
if (id != null) {
filterMap.put("localName", id);
}
clElementStatisticsList.setClElementStatistics(clElementStatisticsProvider.getFilteredClElementStatistics(
name, version, startTime, endTime, filterMap, DESC_ORDER, recordCount));
return clElementStatisticsList;
}
/**
* Get clElement statistics per control loop.
*
* @param name the name of the control loop
* @param version the version of the control loop
* @return the clElement statistics found
* @throws PfModelException on errors getting control loop statistics
*/
public ClElementStatisticsList fetchClElementStatsPerControlLoop(@NonNull final String name,
@NonNull final String version)
throws PfModelException {
ClElementStatisticsList clElementStatisticsList = new ClElementStatisticsList();
List<ClElementStatistics> clElementStats = new ArrayList<>();
try {
List<ControlLoopElement> clElements = new ArrayList<>();
//Fetch all control loop elements for the control loop
ControlLoop controlLoop = controlLoopProvider.getControlLoop(new ToscaConceptIdentifier(name,
version));
if (controlLoop != null) {
clElements.addAll(controlLoop.getElements().values());
//Collect control loop element statistics for each cl element.
for (ControlLoopElement clElement : clElements) {
clElementStats.addAll(fetchFilteredClElementStatistics(clElement.getParticipantId().getName(),
clElement.getParticipantId().getVersion(), clElement.getId().toString(), null,
null, 0).getClElementStatistics());
}
}
clElementStatisticsList.setClElementStatistics(clElementStats);
} catch (PfModelException e) {
throw new PfModelRuntimeException(e);
}
return clElementStatisticsList;
}
/**
* If required, REST end point can be defined for this method to fetch associated participant Ids
* for a control loop.
*
* @param name the name of the control loop
* @param version the version of the control loop
* @return List of participant Id
* @throws PfModelException on errors
*/
public List<ToscaConceptIdentifier> getAllParticipantIdsPerControlLoop(String name, String version)
throws PfModelException {
List<ToscaConceptIdentifier> participantIds = new ArrayList<>();
ControlLoop controlLoop = controlLoopProvider.getControlLoop(new ToscaConceptIdentifier(name, version));
if (controlLoop != null) {
for (ControlLoopElement clElement : controlLoop.getElements().values()) {
participantIds.add(clElement.getParticipantId());
}
}
return participantIds;
}
/**
* If required, REST end point can be defined for this method to fetch associated control loop element Ids
* for a control loop.
*
* @param name the name of the control loop
* @param version the version of the control loop
* @return Map of control loop Id and participant details
* @throws PfModelException on errors
*/
public Map<String, ToscaConceptIdentifier> getAllClElementsIdPerControlLoop(String name, String version)
throws PfModelException {
Map<String, ToscaConceptIdentifier> clElementId = new HashMap<>();
ControlLoop controlLoop = controlLoopProvider.getControlLoop(new ToscaConceptIdentifier(name, version));
if (controlLoop != null) {
for (ControlLoopElement clElement : controlLoop.getElements().values()) {
clElementId.put(clElement.getId().toString(), clElement.getParticipantId());
}
}
return clElementId;
}
public void updateClElementStatistics(List<ClElementStatistics> clElementStatistics) {
// TODO Auto-generated method stub
}
public void updateParticipantStatistics(List<ParticipantStatistics> statisticsList) {
// TODO Auto-generated method stub
}
}
|
