Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 1 | /* |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 2 | * Copyright 2014 Open Networking Laboratory |
Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 3 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 7 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.metrics.topology; |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 17 | |
| 18 | import static org.slf4j.LoggerFactory.getLogger; |
| 19 | |
| 20 | import java.util.LinkedList; |
| 21 | import java.util.List; |
| 22 | |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 23 | import com.google.common.collect.ImmutableList; |
| 24 | import org.apache.felix.scr.annotations.Activate; |
| 25 | import org.apache.felix.scr.annotations.Component; |
| 26 | import org.apache.felix.scr.annotations.Deactivate; |
| 27 | import org.apache.felix.scr.annotations.Reference; |
| 28 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 29 | import org.apache.felix.scr.annotations.Service; |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 30 | import org.onlab.metrics.EventMetric; |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 31 | import org.onlab.metrics.MetricsService; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 32 | import org.onosproject.core.ApplicationId; |
| 33 | import org.onosproject.core.CoreService; |
| 34 | import org.onosproject.event.Event; |
| 35 | import org.onosproject.net.device.DeviceEvent; |
| 36 | import org.onosproject.net.device.DeviceListener; |
| 37 | import org.onosproject.net.device.DeviceService; |
| 38 | import org.onosproject.net.host.HostEvent; |
| 39 | import org.onosproject.net.host.HostListener; |
| 40 | import org.onosproject.net.host.HostService; |
| 41 | import org.onosproject.net.link.LinkEvent; |
| 42 | import org.onosproject.net.link.LinkListener; |
| 43 | import org.onosproject.net.link.LinkService; |
| 44 | import org.onosproject.net.topology.TopologyEvent; |
| 45 | import org.onosproject.net.topology.TopologyListener; |
| 46 | import org.onosproject.net.topology.TopologyService; |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 47 | import org.slf4j.Logger; |
| 48 | |
| 49 | /** |
| 50 | * ONOS Topology Metrics Application that collects topology-related metrics. |
| 51 | */ |
| 52 | @Component(immediate = true) |
| 53 | @Service |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 54 | public class TopologyMetrics implements TopologyMetricsService { |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 55 | private static final Logger log = getLogger(TopologyMetrics.class); |
| 56 | |
| 57 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Pavlin Radoslavov | 3a46e48 | 2014-11-06 15:57:06 -0800 | [diff] [blame] | 58 | protected CoreService coreService; |
| 59 | |
| 60 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 61 | protected DeviceService deviceService; |
Pavlin Radoslavov | 3a46e48 | 2014-11-06 15:57:06 -0800 | [diff] [blame] | 62 | |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 63 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 64 | protected HostService hostService; |
Pavlin Radoslavov | 3a46e48 | 2014-11-06 15:57:06 -0800 | [diff] [blame] | 65 | |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 66 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 67 | protected LinkService linkService; |
Pavlin Radoslavov | 3a46e48 | 2014-11-06 15:57:06 -0800 | [diff] [blame] | 68 | |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 69 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 70 | protected MetricsService metricsService; |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 71 | |
Pavlin Radoslavov | 3a46e48 | 2014-11-06 15:57:06 -0800 | [diff] [blame] | 72 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 73 | protected TopologyService topologyService; |
| 74 | |
| 75 | private ApplicationId appId; |
| 76 | |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 77 | private LinkedList<Event> lastEvents = new LinkedList<>(); |
| 78 | private static final int LAST_EVENTS_MAX_N = 100; |
| 79 | |
| 80 | private final DeviceListener deviceListener = new InnerDeviceListener(); |
| 81 | private final HostListener hostListener = new InnerHostListener(); |
| 82 | private final LinkListener linkListener = new InnerLinkListener(); |
| 83 | private final TopologyListener topologyListener = |
| 84 | new InnerTopologyListener(); |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 85 | |
| 86 | // |
| 87 | // Metrics |
| 88 | // |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 89 | private static final String COMPONENT_NAME = "Topology"; |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 90 | private static final String FEATURE_DEVICE_NAME = "DeviceEvent"; |
| 91 | private static final String FEATURE_HOST_NAME = "HostEvent"; |
| 92 | private static final String FEATURE_LINK_NAME = "LinkEvent"; |
| 93 | private static final String FEATURE_GRAPH_NAME = "GraphEvent"; |
Pavlin Radoslavov | 6aaa1e0 | 2015-03-18 11:12:06 -0700 | [diff] [blame^] | 94 | private static final String FEATURE_GRAPH_REASONS_NAME = "GraphReasonsEvent"; |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 95 | // |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 96 | // Event metrics: |
| 97 | // - Device events |
| 98 | // - Host events |
| 99 | // - Link events |
| 100 | // - Topology Graph events |
Pavlin Radoslavov | 6aaa1e0 | 2015-03-18 11:12:06 -0700 | [diff] [blame^] | 101 | // - Topology Graph Reasons events |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 102 | // |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 103 | private EventMetric topologyDeviceEventMetric; |
| 104 | private EventMetric topologyHostEventMetric; |
| 105 | private EventMetric topologyLinkEventMetric; |
| 106 | private EventMetric topologyGraphEventMetric; |
Pavlin Radoslavov | 6aaa1e0 | 2015-03-18 11:12:06 -0700 | [diff] [blame^] | 107 | private EventMetric topologyGraphReasonsEventMetric; |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 108 | |
| 109 | @Activate |
| 110 | protected void activate() { |
Pavlin Radoslavov | 3a46e48 | 2014-11-06 15:57:06 -0800 | [diff] [blame] | 111 | appId = |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 112 | coreService.registerApplication("org.onosproject.metrics.topology"); |
Pavlin Radoslavov | 3a46e48 | 2014-11-06 15:57:06 -0800 | [diff] [blame] | 113 | |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 114 | clear(); |
| 115 | registerMetrics(); |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 116 | |
| 117 | // Register for all topology-related events |
| 118 | deviceService.addListener(deviceListener); |
| 119 | hostService.addListener(hostListener); |
| 120 | linkService.addListener(linkListener); |
| 121 | topologyService.addListener(topologyListener); |
| 122 | |
Pavlin Radoslavov | 3a46e48 | 2014-11-06 15:57:06 -0800 | [diff] [blame] | 123 | log.info("Started with Application ID {}", appId.id()); |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 124 | } |
| 125 | |
| 126 | @Deactivate |
| 127 | public void deactivate() { |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 128 | // De-register from all topology-related events |
| 129 | deviceService.removeListener(deviceListener); |
| 130 | hostService.removeListener(hostListener); |
| 131 | linkService.removeListener(linkListener); |
| 132 | topologyService.removeListener(topologyListener); |
| 133 | |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 134 | removeMetrics(); |
| 135 | clear(); |
Pavlin Radoslavov | 3a46e48 | 2014-11-06 15:57:06 -0800 | [diff] [blame] | 136 | log.info("Stopped"); |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 137 | } |
| 138 | |
| 139 | @Override |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 140 | public List<Event> getEvents() { |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 141 | synchronized (lastEvents) { |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 142 | return ImmutableList.<Event>copyOf(lastEvents); |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 143 | } |
| 144 | } |
| 145 | |
| 146 | @Override |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 147 | public EventMetric topologyDeviceEventMetric() { |
| 148 | return topologyDeviceEventMetric; |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 149 | } |
| 150 | |
| 151 | @Override |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 152 | public EventMetric topologyHostEventMetric() { |
| 153 | return topologyHostEventMetric; |
| 154 | } |
| 155 | |
| 156 | @Override |
| 157 | public EventMetric topologyLinkEventMetric() { |
| 158 | return topologyLinkEventMetric; |
| 159 | } |
| 160 | |
| 161 | @Override |
| 162 | public EventMetric topologyGraphEventMetric() { |
| 163 | return topologyGraphEventMetric; |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 164 | } |
| 165 | |
Pavlin Radoslavov | 6aaa1e0 | 2015-03-18 11:12:06 -0700 | [diff] [blame^] | 166 | @Override |
| 167 | public EventMetric topologyGraphReasonsEventMetric() { |
| 168 | return topologyGraphReasonsEventMetric; |
| 169 | } |
| 170 | |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 171 | /** |
| 172 | * Records an event. |
| 173 | * |
| 174 | * @param event the event to record |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 175 | * @param eventMetric the Event Metric to use |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 176 | */ |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 177 | private void recordEvent(Event event, EventMetric eventMetric) { |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 178 | synchronized (lastEvents) { |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 179 | eventMetric.eventReceived(); |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 180 | |
| 181 | // |
| 182 | // Keep only the last N events, where N = LAST_EVENTS_MAX_N |
| 183 | // |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 184 | while (lastEvents.size() >= LAST_EVENTS_MAX_N) { |
| 185 | lastEvents.remove(); |
| 186 | } |
| 187 | lastEvents.add(event); |
| 188 | } |
| 189 | } |
| 190 | |
| 191 | /** |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 192 | * Inner Device Event Listener class. |
| 193 | */ |
| 194 | private class InnerDeviceListener implements DeviceListener { |
| 195 | @Override |
| 196 | public void event(DeviceEvent event) { |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 197 | recordEvent(event, topologyDeviceEventMetric); |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 198 | log.debug("Device Event: time = {} type = {} event = {}", |
| 199 | event.time(), event.type(), event); |
| 200 | } |
| 201 | } |
| 202 | |
| 203 | /** |
| 204 | * Inner Host Event Listener class. |
| 205 | */ |
| 206 | private class InnerHostListener implements HostListener { |
| 207 | @Override |
| 208 | public void event(HostEvent event) { |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 209 | recordEvent(event, topologyHostEventMetric); |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 210 | log.debug("Host Event: time = {} type = {} event = {}", |
| 211 | event.time(), event.type(), event); |
| 212 | } |
| 213 | } |
| 214 | |
| 215 | /** |
| 216 | * Inner Link Event Listener class. |
| 217 | */ |
| 218 | private class InnerLinkListener implements LinkListener { |
| 219 | @Override |
| 220 | public void event(LinkEvent event) { |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 221 | recordEvent(event, topologyLinkEventMetric); |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 222 | log.debug("Link Event: time = {} type = {} event = {}", |
| 223 | event.time(), event.type(), event); |
| 224 | } |
| 225 | } |
| 226 | |
| 227 | /** |
| 228 | * Inner Topology Event Listener class. |
| 229 | */ |
| 230 | private class InnerTopologyListener implements TopologyListener { |
| 231 | @Override |
| 232 | public void event(TopologyEvent event) { |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 233 | recordEvent(event, topologyGraphEventMetric); |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 234 | log.debug("Topology Event: time = {} type = {} event = {}", |
| 235 | event.time(), event.type(), event); |
| 236 | for (Event reason : event.reasons()) { |
Pavlin Radoslavov | 6aaa1e0 | 2015-03-18 11:12:06 -0700 | [diff] [blame^] | 237 | recordEvent(event, topologyGraphReasonsEventMetric); |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 238 | log.debug("Topology Event Reason: time = {} type = {} event = {}", |
| 239 | reason.time(), reason.type(), reason); |
| 240 | } |
| 241 | } |
| 242 | } |
| 243 | |
| 244 | /** |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 245 | * Clears the internal state. |
| 246 | */ |
| 247 | private void clear() { |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 248 | synchronized (lastEvents) { |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 249 | lastEvents.clear(); |
| 250 | } |
| 251 | } |
| 252 | |
| 253 | /** |
| 254 | * Registers the metrics. |
| 255 | */ |
| 256 | private void registerMetrics() { |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 257 | topologyDeviceEventMetric = |
| 258 | new EventMetric(metricsService, COMPONENT_NAME, |
| 259 | FEATURE_DEVICE_NAME); |
| 260 | topologyHostEventMetric = |
| 261 | new EventMetric(metricsService, COMPONENT_NAME, |
| 262 | FEATURE_HOST_NAME); |
| 263 | topologyLinkEventMetric = |
| 264 | new EventMetric(metricsService, COMPONENT_NAME, |
| 265 | FEATURE_LINK_NAME); |
| 266 | topologyGraphEventMetric = |
| 267 | new EventMetric(metricsService, COMPONENT_NAME, |
| 268 | FEATURE_GRAPH_NAME); |
Pavlin Radoslavov | 6aaa1e0 | 2015-03-18 11:12:06 -0700 | [diff] [blame^] | 269 | topologyGraphReasonsEventMetric = |
| 270 | new EventMetric(metricsService, COMPONENT_NAME, |
| 271 | FEATURE_GRAPH_REASONS_NAME); |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 272 | |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 273 | topologyDeviceEventMetric.registerMetrics(); |
| 274 | topologyHostEventMetric.registerMetrics(); |
| 275 | topologyLinkEventMetric.registerMetrics(); |
| 276 | topologyGraphEventMetric.registerMetrics(); |
Pavlin Radoslavov | 6aaa1e0 | 2015-03-18 11:12:06 -0700 | [diff] [blame^] | 277 | topologyGraphReasonsEventMetric.registerMetrics(); |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 278 | } |
| 279 | |
| 280 | /** |
| 281 | * Removes the metrics. |
| 282 | */ |
| 283 | private void removeMetrics() { |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 284 | topologyDeviceEventMetric.removeMetrics(); |
| 285 | topologyHostEventMetric.removeMetrics(); |
| 286 | topologyLinkEventMetric.removeMetrics(); |
| 287 | topologyGraphEventMetric.removeMetrics(); |
Pavlin Radoslavov | 6aaa1e0 | 2015-03-18 11:12:06 -0700 | [diff] [blame^] | 288 | topologyGraphReasonsEventMetric.removeMetrics(); |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 289 | } |
| 290 | } |