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