Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 1 | package org.onlab.onos.metrics.topology; |
| 2 | |
| 3 | import static org.slf4j.LoggerFactory.getLogger; |
| 4 | |
| 5 | import java.util.LinkedList; |
| 6 | import java.util.List; |
| 7 | |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 8 | import com.google.common.collect.ImmutableList; |
| 9 | import org.apache.felix.scr.annotations.Activate; |
| 10 | import org.apache.felix.scr.annotations.Component; |
| 11 | import org.apache.felix.scr.annotations.Deactivate; |
| 12 | import org.apache.felix.scr.annotations.Reference; |
| 13 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 14 | import org.apache.felix.scr.annotations.Service; |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 15 | import org.onlab.metrics.EventMetric; |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 16 | import org.onlab.metrics.MetricsService; |
| 17 | import org.onlab.onos.event.Event; |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 18 | import org.onlab.onos.net.device.DeviceEvent; |
| 19 | import org.onlab.onos.net.device.DeviceListener; |
| 20 | import org.onlab.onos.net.device.DeviceService; |
| 21 | import org.onlab.onos.net.host.HostEvent; |
| 22 | import org.onlab.onos.net.host.HostListener; |
| 23 | import org.onlab.onos.net.host.HostService; |
| 24 | import org.onlab.onos.net.link.LinkEvent; |
| 25 | import org.onlab.onos.net.link.LinkListener; |
| 26 | import org.onlab.onos.net.link.LinkService; |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 27 | import org.onlab.onos.net.topology.TopologyEvent; |
| 28 | import org.onlab.onos.net.topology.TopologyListener; |
| 29 | import org.onlab.onos.net.topology.TopologyService; |
| 30 | import org.slf4j.Logger; |
| 31 | |
| 32 | /** |
| 33 | * ONOS Topology Metrics Application that collects topology-related metrics. |
| 34 | */ |
| 35 | @Component(immediate = true) |
| 36 | @Service |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 37 | public class TopologyMetrics implements TopologyMetricsService { |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 38 | private static final Logger log = getLogger(TopologyMetrics.class); |
| 39 | |
| 40 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 41 | protected DeviceService deviceService; |
| 42 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 43 | protected HostService hostService; |
| 44 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 45 | protected LinkService linkService; |
| 46 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 47 | protected TopologyService topologyService; |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 48 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 49 | protected MetricsService metricsService; |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 50 | |
| 51 | private LinkedList<Event> lastEvents = new LinkedList<>(); |
| 52 | private static final int LAST_EVENTS_MAX_N = 100; |
| 53 | |
| 54 | private final DeviceListener deviceListener = new InnerDeviceListener(); |
| 55 | private final HostListener hostListener = new InnerHostListener(); |
| 56 | private final LinkListener linkListener = new InnerLinkListener(); |
| 57 | private final TopologyListener topologyListener = |
| 58 | new InnerTopologyListener(); |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 59 | |
| 60 | // |
| 61 | // Metrics |
| 62 | // |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 63 | private static final String COMPONENT_NAME = "Topology"; |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 64 | private static final String FEATURE_DEVICE_NAME = "DeviceEvent"; |
| 65 | private static final String FEATURE_HOST_NAME = "HostEvent"; |
| 66 | private static final String FEATURE_LINK_NAME = "LinkEvent"; |
| 67 | private static final String FEATURE_GRAPH_NAME = "GraphEvent"; |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 68 | // |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 69 | // Event metrics: |
| 70 | // - Device events |
| 71 | // - Host events |
| 72 | // - Link events |
| 73 | // - Topology Graph events |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 74 | // |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 75 | private EventMetric topologyDeviceEventMetric; |
| 76 | private EventMetric topologyHostEventMetric; |
| 77 | private EventMetric topologyLinkEventMetric; |
| 78 | private EventMetric topologyGraphEventMetric; |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 79 | |
| 80 | @Activate |
| 81 | protected void activate() { |
| 82 | clear(); |
| 83 | registerMetrics(); |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 84 | |
| 85 | // Register for all topology-related events |
| 86 | deviceService.addListener(deviceListener); |
| 87 | hostService.addListener(hostListener); |
| 88 | linkService.addListener(linkListener); |
| 89 | topologyService.addListener(topologyListener); |
| 90 | |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 91 | log.info("ONOS Topology Metrics started."); |
| 92 | } |
| 93 | |
| 94 | @Deactivate |
| 95 | public void deactivate() { |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 96 | // De-register from all topology-related events |
| 97 | deviceService.removeListener(deviceListener); |
| 98 | hostService.removeListener(hostListener); |
| 99 | linkService.removeListener(linkListener); |
| 100 | topologyService.removeListener(topologyListener); |
| 101 | |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 102 | removeMetrics(); |
| 103 | clear(); |
| 104 | log.info("ONOS Topology Metrics stopped."); |
| 105 | } |
| 106 | |
| 107 | @Override |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 108 | public List<Event> getEvents() { |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 109 | synchronized (lastEvents) { |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 110 | return ImmutableList.<Event>copyOf(lastEvents); |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 111 | } |
| 112 | } |
| 113 | |
| 114 | @Override |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 115 | public EventMetric topologyDeviceEventMetric() { |
| 116 | return topologyDeviceEventMetric; |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 117 | } |
| 118 | |
| 119 | @Override |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 120 | public EventMetric topologyHostEventMetric() { |
| 121 | return topologyHostEventMetric; |
| 122 | } |
| 123 | |
| 124 | @Override |
| 125 | public EventMetric topologyLinkEventMetric() { |
| 126 | return topologyLinkEventMetric; |
| 127 | } |
| 128 | |
| 129 | @Override |
| 130 | public EventMetric topologyGraphEventMetric() { |
| 131 | return topologyGraphEventMetric; |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 132 | } |
| 133 | |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 134 | /** |
| 135 | * Records an event. |
| 136 | * |
| 137 | * @param event the event to record |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 138 | * @param eventMetric the Event Metric to use |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 139 | */ |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 140 | private void recordEvent(Event event, EventMetric eventMetric) { |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 141 | synchronized (lastEvents) { |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 142 | eventMetric.eventReceived(); |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 143 | |
| 144 | // |
| 145 | // Keep only the last N events, where N = LAST_EVENTS_MAX_N |
| 146 | // |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 147 | while (lastEvents.size() >= LAST_EVENTS_MAX_N) { |
| 148 | lastEvents.remove(); |
| 149 | } |
| 150 | lastEvents.add(event); |
| 151 | } |
| 152 | } |
| 153 | |
| 154 | /** |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 155 | * Inner Device Event Listener class. |
| 156 | */ |
| 157 | private class InnerDeviceListener implements DeviceListener { |
| 158 | @Override |
| 159 | public void event(DeviceEvent event) { |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 160 | recordEvent(event, topologyDeviceEventMetric); |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 161 | log.debug("Device Event: time = {} type = {} event = {}", |
| 162 | event.time(), event.type(), event); |
| 163 | } |
| 164 | } |
| 165 | |
| 166 | /** |
| 167 | * Inner Host Event Listener class. |
| 168 | */ |
| 169 | private class InnerHostListener implements HostListener { |
| 170 | @Override |
| 171 | public void event(HostEvent event) { |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 172 | recordEvent(event, topologyHostEventMetric); |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 173 | log.debug("Host Event: time = {} type = {} event = {}", |
| 174 | event.time(), event.type(), event); |
| 175 | } |
| 176 | } |
| 177 | |
| 178 | /** |
| 179 | * Inner Link Event Listener class. |
| 180 | */ |
| 181 | private class InnerLinkListener implements LinkListener { |
| 182 | @Override |
| 183 | public void event(LinkEvent event) { |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 184 | recordEvent(event, topologyLinkEventMetric); |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 185 | log.debug("Link Event: time = {} type = {} event = {}", |
| 186 | event.time(), event.type(), event); |
| 187 | } |
| 188 | } |
| 189 | |
| 190 | /** |
| 191 | * Inner Topology Event Listener class. |
| 192 | */ |
| 193 | private class InnerTopologyListener implements TopologyListener { |
| 194 | @Override |
| 195 | public void event(TopologyEvent event) { |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 196 | recordEvent(event, topologyGraphEventMetric); |
Pavlin Radoslavov | 5ba8b28 | 2014-10-23 01:03:10 -0700 | [diff] [blame] | 197 | log.debug("Topology Event: time = {} type = {} event = {}", |
| 198 | event.time(), event.type(), event); |
| 199 | for (Event reason : event.reasons()) { |
| 200 | log.debug("Topology Event Reason: time = {} type = {} event = {}", |
| 201 | reason.time(), reason.type(), reason); |
| 202 | } |
| 203 | } |
| 204 | } |
| 205 | |
| 206 | /** |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 207 | * Clears the internal state. |
| 208 | */ |
| 209 | private void clear() { |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 210 | synchronized (lastEvents) { |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 211 | lastEvents.clear(); |
| 212 | } |
| 213 | } |
| 214 | |
| 215 | /** |
| 216 | * Registers the metrics. |
| 217 | */ |
| 218 | private void registerMetrics() { |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 219 | topologyDeviceEventMetric = |
| 220 | new EventMetric(metricsService, COMPONENT_NAME, |
| 221 | FEATURE_DEVICE_NAME); |
| 222 | topologyHostEventMetric = |
| 223 | new EventMetric(metricsService, COMPONENT_NAME, |
| 224 | FEATURE_HOST_NAME); |
| 225 | topologyLinkEventMetric = |
| 226 | new EventMetric(metricsService, COMPONENT_NAME, |
| 227 | FEATURE_LINK_NAME); |
| 228 | topologyGraphEventMetric = |
| 229 | new EventMetric(metricsService, COMPONENT_NAME, |
| 230 | FEATURE_GRAPH_NAME); |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 231 | |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 232 | topologyDeviceEventMetric.registerMetrics(); |
| 233 | topologyHostEventMetric.registerMetrics(); |
| 234 | topologyLinkEventMetric.registerMetrics(); |
| 235 | topologyGraphEventMetric.registerMetrics(); |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 236 | } |
| 237 | |
| 238 | /** |
| 239 | * Removes the metrics. |
| 240 | */ |
| 241 | private void removeMetrics() { |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 242 | topologyDeviceEventMetric.removeMetrics(); |
| 243 | topologyHostEventMetric.removeMetrics(); |
| 244 | topologyLinkEventMetric.removeMetrics(); |
| 245 | topologyGraphEventMetric.removeMetrics(); |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 246 | } |
| 247 | } |