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
|
/*
* Copyright 2014-2015 Open Networking Laboratory
*
* 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.
*/
package org.onosproject.metrics.intent;
import static org.slf4j.LoggerFactory.getLogger;
import java.util.LinkedList;
import java.util.List;
import com.google.common.collect.ImmutableList;
import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Deactivate;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.ReferenceCardinality;
import org.apache.felix.scr.annotations.Service;
import org.onlab.metrics.EventMetric;
import org.onlab.metrics.MetricsService;
import org.onosproject.core.ApplicationId;
import org.onosproject.core.CoreService;
import org.onosproject.net.intent.IntentEvent;
import org.onosproject.net.intent.IntentListener;
import org.onosproject.net.intent.IntentService;
import org.slf4j.Logger;
/**
* ONOS Intent Metrics Application that collects intent-related metrics.
*/
@Component(immediate = true)
@Service
public class IntentMetrics implements IntentMetricsService,
IntentListener {
private static final Logger log = getLogger(IntentMetrics.class);
@Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
protected CoreService coreService;
@Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
protected IntentService intentService;
@Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
protected MetricsService metricsService;
private ApplicationId appId;
private LinkedList<IntentEvent> lastEvents = new LinkedList<>();
private static final int LAST_EVENTS_MAX_N = 100;
//
// Metrics
//
private static final String COMPONENT_NAME = "Intent";
private static final String FEATURE_SUBMITTED_NAME = "Submitted";
private static final String FEATURE_INSTALLED_NAME = "Installed";
private static final String FEATURE_FAILED_NAME = "Failed";
private static final String FEATURE_WITHDRAW_REQUESTED_NAME =
"WithdrawRequested";
private static final String FEATURE_WITHDRAWN_NAME = "Withdrawn";
private static final String FEATURE_PURGED_NAME = "Purged";
//
// Event metrics:
// - Intent Submitted API operation
// - Intent Installed operation completion
// - Intent Failed compilation or installation
// - Intent Withdraw Requested API operation
// - Intent Withdrawn operation completion
// - Intent Purged operation completion
//
private EventMetric intentSubmittedEventMetric;
private EventMetric intentInstalledEventMetric;
private EventMetric intentFailedEventMetric;
private EventMetric intentWithdrawRequestedEventMetric;
private EventMetric intentWithdrawnEventMetric;
private EventMetric intentPurgedEventMetric;
@Activate
protected void activate() {
appId = coreService.registerApplication("org.onosproject.metrics");
clear();
registerMetrics();
intentService.addListener(this);
log.info("Started with Application ID {}", appId.id());
}
@Deactivate
public void deactivate() {
intentService.removeListener(this);
removeMetrics();
clear();
log.info("Stopped");
}
@Override
public List<IntentEvent> getEvents() {
synchronized (lastEvents) {
return ImmutableList.copyOf(lastEvents);
}
}
@Override
public EventMetric intentSubmittedEventMetric() {
return intentSubmittedEventMetric;
}
@Override
public EventMetric intentInstalledEventMetric() {
return intentInstalledEventMetric;
}
@Override
public EventMetric intentFailedEventMetric() {
return intentFailedEventMetric;
}
@Override
public EventMetric intentWithdrawRequestedEventMetric() {
return intentWithdrawRequestedEventMetric;
}
@Override
public EventMetric intentWithdrawnEventMetric() {
return intentWithdrawnEventMetric;
}
@Override
public EventMetric intentPurgedEventMetric() {
return intentPurgedEventMetric;
}
@Override
public void event(IntentEvent event) {
synchronized (lastEvents) {
switch (event.type()) {
case INSTALL_REQ:
intentSubmittedEventMetric.eventReceived();
break;
case INSTALLED:
intentInstalledEventMetric.eventReceived();
break;
case FAILED:
intentFailedEventMetric.eventReceived();
break;
case WITHDRAW_REQ:
intentWithdrawRequestedEventMetric.eventReceived();
break;
case WITHDRAWN:
intentWithdrawnEventMetric.eventReceived();
break;
case PURGED:
intentPurgedEventMetric.eventReceived();
break;
default:
break;
}
//
// Keep only the last N events, where N = LAST_EVENTS_MAX_N
//
while (lastEvents.size() >= LAST_EVENTS_MAX_N) {
lastEvents.remove();
}
lastEvents.add(event);
}
log.debug("Intent Event: time = {} type = {} event = {}",
event.time(), event.type(), event);
}
/**
* Clears the internal state.
*/
private void clear() {
synchronized (lastEvents) {
lastEvents.clear();
}
}
/**
* Registers the metrics.
*/
private void registerMetrics() {
intentSubmittedEventMetric =
new EventMetric(metricsService, COMPONENT_NAME,
FEATURE_SUBMITTED_NAME);
intentInstalledEventMetric =
new EventMetric(metricsService, COMPONENT_NAME,
FEATURE_INSTALLED_NAME);
intentFailedEventMetric =
new EventMetric(metricsService, COMPONENT_NAME,
FEATURE_FAILED_NAME);
intentWithdrawRequestedEventMetric =
new EventMetric(metricsService, COMPONENT_NAME,
FEATURE_WITHDRAW_REQUESTED_NAME);
intentWithdrawnEventMetric =
new EventMetric(metricsService, COMPONENT_NAME,
FEATURE_WITHDRAWN_NAME);
intentPurgedEventMetric =
new EventMetric(metricsService, COMPONENT_NAME,
FEATURE_PURGED_NAME);
intentSubmittedEventMetric.registerMetrics();
intentInstalledEventMetric.registerMetrics();
intentFailedEventMetric.registerMetrics();
intentWithdrawRequestedEventMetric.registerMetrics();
intentWithdrawnEventMetric.registerMetrics();
intentPurgedEventMetric.registerMetrics();
}
/**
* Removes the metrics.
*/
private void removeMetrics() {
intentSubmittedEventMetric.removeMetrics();
intentInstalledEventMetric.removeMetrics();
intentFailedEventMetric.removeMetrics();
intentWithdrawRequestedEventMetric.removeMetrics();
intentWithdrawnEventMetric.removeMetrics();
intentPurgedEventMetric.removeMetrics();
}
}
|
