2 * Copyright IBM Corporation, 2013. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.md.statistics.manager;
10 import java.util.ArrayList;
11 import java.util.List;
12 import java.util.concurrent.ConcurrentHashMap;
13 import java.util.concurrent.ConcurrentMap;
14 import java.util.concurrent.ExecutionException;
15 import java.util.concurrent.Future;
17 import org.eclipse.xtext.xbase.lib.Exceptions;
18 import org.opendaylight.controller.md.statistics.manager.MultipartMessageManager.StatsRequestType;
19 import org.opendaylight.controller.sal.binding.api.NotificationProviderService;
20 import org.opendaylight.controller.sal.binding.api.data.DataBrokerService;
21 import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction;
22 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.Meter;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetAggregateFlowStatisticsFromFlowTableForAllFlowsInputBuilder;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetAggregateFlowStatisticsFromFlowTableForAllFlowsOutput;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetAllFlowsStatisticsFromAllFlowTablesInputBuilder;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetAllFlowsStatisticsFromAllFlowTablesOutput;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetFlowStatisticsFromFlowTableInputBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetFlowStatisticsFromFlowTableOutput;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.OpendaylightFlowStatisticsService;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.GetFlowTablesStatisticsInputBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.GetFlowTablesStatisticsOutput;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.OpendaylightFlowTableStatisticsService;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.queues.Queue;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.queue.rev130925.QueueId;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GetAllGroupStatisticsInputBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GetAllGroupStatisticsOutput;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GetGroupDescriptionInputBuilder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GetGroupDescriptionOutput;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.OpendaylightGroupStatisticsService;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.GetAllMeterConfigStatisticsInputBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.GetAllMeterConfigStatisticsOutput;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.GetAllMeterStatisticsInputBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.GetAllMeterStatisticsOutput;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.OpendaylightMeterStatisticsService;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.GetAllNodeConnectorsStatisticsInputBuilder;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.GetAllNodeConnectorsStatisticsOutput;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.OpendaylightPortStatisticsService;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.GetAllQueuesStatisticsFromAllPortsInputBuilder;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.GetAllQueuesStatisticsFromAllPortsOutput;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.GetQueueStatisticsFromGivenPortInputBuilder;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.GetQueueStatisticsFromGivenPortOutput;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.OpendaylightQueueStatisticsService;
66 import org.opendaylight.yangtools.concepts.Registration;
67 import org.opendaylight.yangtools.yang.binding.DataObject;
68 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
69 import org.opendaylight.yangtools.yang.binding.NotificationListener;
70 import org.opendaylight.yangtools.yang.common.RpcResult;
71 import org.slf4j.Logger;
72 import org.slf4j.LoggerFactory;
75 * Following are main responsibilities of the class:
76 * 1) Invoke statistics request thread to send periodic statistics request to all the
77 * flow capable switch connected to the controller. It sends statistics request for
78 * Group,Meter,Table,Flow,Queue,Aggregate stats.
80 * 2) Invoke statistics ager thread, to clean up all the stale statistics data from
81 * operational data store.
83 * @author avishnoi@in.ibm.com
86 public class StatisticsProvider implements AutoCloseable {
88 public final static Logger spLogger = LoggerFactory.getLogger(StatisticsProvider.class);
90 private DataProviderService dps;
92 private DataBrokerService dbs;
94 private NotificationProviderService nps;
96 private OpendaylightGroupStatisticsService groupStatsService;
98 private OpendaylightMeterStatisticsService meterStatsService;
100 private OpendaylightFlowStatisticsService flowStatsService;
102 private OpendaylightPortStatisticsService portStatsService;
104 private OpendaylightFlowTableStatisticsService flowTableStatsService;
106 private OpendaylightQueueStatisticsService queueStatsService;
108 private final MultipartMessageManager multipartMessageManager = new MultipartMessageManager();
110 private StatisticsUpdateHandler statsUpdateHandler;
112 private Thread statisticsRequesterThread;
114 private Thread statisticsAgerThread;
116 private final InstanceIdentifier<Nodes> nodesIdentifier = InstanceIdentifier.builder(Nodes.class).toInstance();
118 public static final int STATS_THREAD_EXECUTION_TIME= 30000;
119 //Local caching of stats
121 private final ConcurrentMap<NodeId,NodeStatisticsAger> statisticsCache =
122 new ConcurrentHashMap<NodeId,NodeStatisticsAger>();
124 public DataProviderService getDataService() {
128 public void setDataService(final DataProviderService dataService) {
129 this.dps = dataService;
132 public DataBrokerService getDataBrokerService() {
136 public void setDataBrokerService(final DataBrokerService dataBrokerService) {
137 this.dbs = dataBrokerService;
140 public NotificationProviderService getNotificationService() {
144 public void setNotificationService(final NotificationProviderService notificationService) {
145 this.nps = notificationService;
148 public MultipartMessageManager getMultipartMessageManager() {
149 return multipartMessageManager;
152 private final StatisticsUpdateCommiter updateCommiter = new StatisticsUpdateCommiter(StatisticsProvider.this);
154 private Registration<NotificationListener> listenerRegistration;
156 public void start() {
158 NotificationProviderService nps = this.getNotificationService();
159 Registration<NotificationListener> registerNotificationListener = nps.registerNotificationListener(this.updateCommiter);
160 this.listenerRegistration = registerNotificationListener;
162 statsUpdateHandler = new StatisticsUpdateHandler(StatisticsProvider.this);
164 registerDataStoreUpdateListener(this.getDataBrokerService());
166 // Get Group/Meter statistics service instance
167 groupStatsService = StatisticsManagerActivator.getProviderContext().
168 getRpcService(OpendaylightGroupStatisticsService.class);
170 meterStatsService = StatisticsManagerActivator.getProviderContext().
171 getRpcService(OpendaylightMeterStatisticsService.class);
173 flowStatsService = StatisticsManagerActivator.getProviderContext().
174 getRpcService(OpendaylightFlowStatisticsService.class);
176 portStatsService = StatisticsManagerActivator.getProviderContext().
177 getRpcService(OpendaylightPortStatisticsService.class);
179 flowTableStatsService = StatisticsManagerActivator.getProviderContext().
180 getRpcService(OpendaylightFlowTableStatisticsService.class);
182 queueStatsService = StatisticsManagerActivator.getProviderContext().
183 getRpcService(OpendaylightQueueStatisticsService.class);
185 statisticsRequesterThread = new Thread( new Runnable(){
191 statsRequestSender();
193 Thread.sleep(STATS_THREAD_EXECUTION_TIME);
194 }catch (Exception e){
195 spLogger.error("Exception occurred while sending stats request : {}",e);
201 spLogger.debug("Statistics requester thread started with timer interval : {}",STATS_THREAD_EXECUTION_TIME);
203 statisticsRequesterThread.start();
205 statisticsAgerThread = new Thread( new Runnable(){
211 for(NodeStatisticsAger nodeStatisticsAger : statisticsCache.values()){
212 nodeStatisticsAger.cleanStaleStatistics();
215 Thread.sleep(STATS_THREAD_EXECUTION_TIME);
216 }catch (Exception e){
217 spLogger.error("Exception occurred while sending stats request : {}",e);
223 spLogger.debug("Statistics ager thread started with timer interval : {}",STATS_THREAD_EXECUTION_TIME);
225 statisticsAgerThread.start();
227 spLogger.info("Statistics Provider started.");
230 private void registerDataStoreUpdateListener(DataBrokerService dbs) {
231 //Register for flow updates
232 InstanceIdentifier<? extends DataObject> pathFlow = InstanceIdentifier.builder(Nodes.class).child(Node.class)
233 .augmentation(FlowCapableNode.class)
235 .child(Flow.class).toInstance();
236 dbs.registerDataChangeListener(pathFlow, statsUpdateHandler);
238 //Register for meter updates
239 InstanceIdentifier<? extends DataObject> pathMeter = InstanceIdentifier.builder(Nodes.class).child(Node.class)
240 .augmentation(FlowCapableNode.class)
241 .child(Meter.class).toInstance();
243 dbs.registerDataChangeListener(pathMeter, statsUpdateHandler);
245 //Register for group updates
246 InstanceIdentifier<? extends DataObject> pathGroup = InstanceIdentifier.builder(Nodes.class).child(Node.class)
247 .augmentation(FlowCapableNode.class)
248 .child(Group.class).toInstance();
249 dbs.registerDataChangeListener(pathGroup, statsUpdateHandler);
251 //Register for queue updates
252 InstanceIdentifier<? extends DataObject> pathQueue = InstanceIdentifier.builder(Nodes.class).child(Node.class)
253 .child(NodeConnector.class)
254 .augmentation(FlowCapableNodeConnector.class)
255 .child(Queue.class).toInstance();
256 dbs.registerDataChangeListener(pathQueue, statsUpdateHandler);
259 protected DataModificationTransaction startChange() {
261 DataProviderService dps = this.getDataService();
262 return dps.beginTransaction();
265 private void statsRequestSender(){
267 List<Node> targetNodes = getAllConnectedNodes();
269 if(targetNodes == null)
273 for (Node targetNode : targetNodes){
275 if(targetNode.getAugmentation(FlowCapableNode.class) != null){
277 spLogger.info("Send request for stats collection to node : {})",targetNode.getId());
279 InstanceIdentifier<Node> targetInstanceId = InstanceIdentifier.builder(Nodes.class).child(Node.class,targetNode.getKey()).toInstance();
281 NodeRef targetNodeRef = new NodeRef(targetInstanceId);
284 sendAggregateFlowsStatsFromAllTablesRequest(targetNode.getKey());
286 sendAllFlowsStatsFromAllTablesRequest(targetNodeRef);
288 sendAllNodeConnectorsStatisticsRequest(targetNodeRef);
290 sendAllFlowTablesStatisticsRequest(targetNodeRef);
292 sendAllQueueStatsFromAllNodeConnector (targetNodeRef);
294 sendAllGroupStatisticsRequest(targetNodeRef);
296 sendAllMeterStatisticsRequest(targetNodeRef);
298 sendGroupDescriptionRequest(targetNodeRef);
300 sendMeterConfigStatisticsRequest(targetNodeRef);
302 spLogger.error("Exception occured while sending statistics requests : {}", e);
308 public void sendAllFlowTablesStatisticsRequest(NodeRef targetNodeRef) throws InterruptedException, ExecutionException {
309 final GetFlowTablesStatisticsInputBuilder input =
310 new GetFlowTablesStatisticsInputBuilder();
312 input.setNode(targetNodeRef);
314 Future<RpcResult<GetFlowTablesStatisticsOutput>> response =
315 flowTableStatsService.getFlowTablesStatistics(input.build());
317 this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
318 , StatsRequestType.ALL_FLOW_TABLE);
322 public void sendAllFlowsStatsFromAllTablesRequest(NodeRef targetNode) throws InterruptedException, ExecutionException{
323 final GetAllFlowsStatisticsFromAllFlowTablesInputBuilder input =
324 new GetAllFlowsStatisticsFromAllFlowTablesInputBuilder();
326 input.setNode(targetNode);
328 Future<RpcResult<GetAllFlowsStatisticsFromAllFlowTablesOutput>> response =
329 flowStatsService.getAllFlowsStatisticsFromAllFlowTables(input.build());
331 this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
332 , StatsRequestType.ALL_FLOW);
336 public void sendFlowStatsFromTableRequest(NodeRef targetNode,Flow flow) throws InterruptedException, ExecutionException{
337 final GetFlowStatisticsFromFlowTableInputBuilder input =
338 new GetFlowStatisticsFromFlowTableInputBuilder();
340 input.setNode(targetNode);
341 input.fieldsFrom(flow);
343 Future<RpcResult<GetFlowStatisticsFromFlowTableOutput>> response =
344 flowStatsService.getFlowStatisticsFromFlowTable(input.build());
346 this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
347 , StatsRequestType.ALL_FLOW);
351 public void sendAggregateFlowsStatsFromAllTablesRequest(NodeKey targetNodeKey) throws InterruptedException, ExecutionException{
353 List<Short> tablesId = getTablesFromNode(targetNodeKey);
355 if(tablesId.size() != 0){
356 for(Short id : tablesId){
358 spLogger.info("Send aggregate stats request for flow table {} to node {}",id,targetNodeKey);
359 GetAggregateFlowStatisticsFromFlowTableForAllFlowsInputBuilder input =
360 new GetAggregateFlowStatisticsFromFlowTableForAllFlowsInputBuilder();
362 input.setNode(new NodeRef(InstanceIdentifier.builder(Nodes.class).child(Node.class, targetNodeKey).toInstance()));
363 input.setTableId(new org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableId(id));
364 Future<RpcResult<GetAggregateFlowStatisticsFromFlowTableForAllFlowsOutput>> response =
365 flowStatsService.getAggregateFlowStatisticsFromFlowTableForAllFlows(input.build());
367 multipartMessageManager.setTxIdAndTableIdMapEntry(response.get().getResult().getTransactionId(), id);
368 this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
369 , StatsRequestType.AGGR_FLOW);
372 spLogger.debug("No details found in data store for flow tables associated with Node {}",targetNodeKey);
376 public void sendAllNodeConnectorsStatisticsRequest(NodeRef targetNode) throws InterruptedException, ExecutionException{
378 final GetAllNodeConnectorsStatisticsInputBuilder input = new GetAllNodeConnectorsStatisticsInputBuilder();
380 input.setNode(targetNode);
382 Future<RpcResult<GetAllNodeConnectorsStatisticsOutput>> response =
383 portStatsService.getAllNodeConnectorsStatistics(input.build());
384 this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
385 , StatsRequestType.ALL_PORT);
389 public void sendAllGroupStatisticsRequest(NodeRef targetNode) throws InterruptedException, ExecutionException{
391 final GetAllGroupStatisticsInputBuilder input = new GetAllGroupStatisticsInputBuilder();
393 input.setNode(targetNode);
395 Future<RpcResult<GetAllGroupStatisticsOutput>> response =
396 groupStatsService.getAllGroupStatistics(input.build());
398 this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
399 , StatsRequestType.ALL_GROUP);
403 public void sendGroupDescriptionRequest(NodeRef targetNode) throws InterruptedException, ExecutionException{
404 final GetGroupDescriptionInputBuilder input = new GetGroupDescriptionInputBuilder();
406 input.setNode(targetNode);
408 Future<RpcResult<GetGroupDescriptionOutput>> response =
409 groupStatsService.getGroupDescription(input.build());
411 this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
412 , StatsRequestType.GROUP_DESC);
416 public void sendAllMeterStatisticsRequest(NodeRef targetNode) throws InterruptedException, ExecutionException{
418 GetAllMeterStatisticsInputBuilder input = new GetAllMeterStatisticsInputBuilder();
420 input.setNode(targetNode);
422 Future<RpcResult<GetAllMeterStatisticsOutput>> response =
423 meterStatsService.getAllMeterStatistics(input.build());
425 this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
426 , StatsRequestType.ALL_METER);;
430 public void sendMeterConfigStatisticsRequest(NodeRef targetNode) throws InterruptedException, ExecutionException{
432 GetAllMeterConfigStatisticsInputBuilder input = new GetAllMeterConfigStatisticsInputBuilder();
434 input.setNode(targetNode);
436 Future<RpcResult<GetAllMeterConfigStatisticsOutput>> response =
437 meterStatsService.getAllMeterConfigStatistics(input.build());
439 this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
440 , StatsRequestType.METER_CONFIG);;
444 public void sendAllQueueStatsFromAllNodeConnector(NodeRef targetNode) throws InterruptedException, ExecutionException {
445 GetAllQueuesStatisticsFromAllPortsInputBuilder input = new GetAllQueuesStatisticsFromAllPortsInputBuilder();
447 input.setNode(targetNode);
449 Future<RpcResult<GetAllQueuesStatisticsFromAllPortsOutput>> response =
450 queueStatsService.getAllQueuesStatisticsFromAllPorts(input.build());
452 this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
453 , StatsRequestType.ALL_QUEUE_STATS);;
457 public void sendQueueStatsFromGivenNodeConnector(NodeRef targetNode,NodeConnectorId nodeConnectorId, QueueId queueId) throws InterruptedException, ExecutionException {
458 GetQueueStatisticsFromGivenPortInputBuilder input = new GetQueueStatisticsFromGivenPortInputBuilder();
460 input.setNode(targetNode);
461 input.setNodeConnectorId(nodeConnectorId);
462 input.setQueueId(queueId);
463 Future<RpcResult<GetQueueStatisticsFromGivenPortOutput>> response =
464 queueStatsService.getQueueStatisticsFromGivenPort(input.build());
466 this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
467 , StatsRequestType.ALL_QUEUE_STATS);;
471 public ConcurrentMap<NodeId, NodeStatisticsAger> getStatisticsCache() {
472 return statisticsCache;
475 private List<Node> getAllConnectedNodes(){
477 Nodes nodes = (Nodes) dps.readOperationalData(nodesIdentifier);
481 spLogger.info("Number of connected nodes : {}",nodes.getNode().size());
482 return nodes.getNode();
485 private List<Short> getTablesFromNode(NodeKey nodeKey){
486 InstanceIdentifier<FlowCapableNode> nodesIdentifier = InstanceIdentifier.builder(Nodes.class).child(Node.class,nodeKey).augmentation(FlowCapableNode.class).toInstance();
488 FlowCapableNode node = (FlowCapableNode)dps.readOperationalData(nodesIdentifier);
489 List<Short> tablesId = new ArrayList<Short>();
490 if(node != null && node.getTable()!=null){
491 spLogger.info("Number of tables {} supported by node {}",node.getTable().size(),nodeKey);
492 for(Table table: node.getTable()){
493 tablesId.add(table.getId());
499 @SuppressWarnings("deprecation")
504 spLogger.info("Statistics Provider stopped.");
505 if (this.listenerRegistration != null) {
507 this.listenerRegistration.close();
509 this.statisticsRequesterThread.destroy();
511 this.statisticsAgerThread.destroy();
514 } catch (Throwable e) {
515 throw Exceptions.sneakyThrow(e);