opendaylight/md-sal/statistics-manager/src/main/java/org/opendaylight/controller/md/statistics/manager/StatisticsProvider.java

   1 /*
   2  * Copyright IBM Corporation, 2013.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.md.statistics.manager;
   9
  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;
  16
  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.DataModificationTransaction;
  21 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetAggregateFlowStatisticsFromFlowTableForAllFlowsInputBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetAggregateFlowStatisticsFromFlowTableForAllFlowsOutput;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetAllFlowsStatisticsFromAllFlowTablesInputBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.GetAllFlowsStatisticsFromAllFlowTablesOutput;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.OpendaylightFlowStatisticsService;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.GetFlowTablesStatisticsInputBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.GetFlowTablesStatisticsOutput;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.OpendaylightFlowTableStatisticsService;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GetAllGroupStatisticsInputBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GetAllGroupStatisticsOutput;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GetGroupDescriptionInputBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GetGroupDescriptionOutput;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.OpendaylightGroupStatisticsService;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.GetAllMeterConfigStatisticsInputBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.GetAllMeterConfigStatisticsOutput;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.GetAllMeterStatisticsInputBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.GetAllMeterStatisticsOutput;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.OpendaylightMeterStatisticsService;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.GetAllNodeConnectorsStatisticsInputBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.GetAllNodeConnectorsStatisticsOutput;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.OpendaylightPortStatisticsService;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.GetAllQueuesStatisticsFromAllPortsInputBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.GetAllQueuesStatisticsFromAllPortsOutput;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.OpendaylightQueueStatisticsService;
  53 import org.opendaylight.yangtools.concepts.Registration;
  54 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  55 import org.opendaylight.yangtools.yang.binding.NotificationListener;
  56 import org.opendaylight.yangtools.yang.common.RpcResult;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 public class StatisticsProvider implements AutoCloseable {
  61
  62     public final static Logger spLogger = LoggerFactory.getLogger(StatisticsProvider.class);
  63
  64     private DataProviderService dps;
  65
  66     private NotificationProviderService nps;
  67
  68     private OpendaylightGroupStatisticsService groupStatsService;
  69
  70     private OpendaylightMeterStatisticsService meterStatsService;
  71
  72     private OpendaylightFlowStatisticsService flowStatsService;
  73
  74     private OpendaylightPortStatisticsService portStatsService;
  75
  76     private OpendaylightFlowTableStatisticsService flowTableStatsService;
  77
  78     private OpendaylightQueueStatisticsService queueStatsService;
  79
  80     private final MultipartMessageManager multipartMessageManager = new MultipartMessageManager();
  81
  82     private Thread statisticsRequesterThread;
  83
  84     private final  InstanceIdentifier<Nodes> nodesIdentifier = InstanceIdentifier.builder(Nodes.class).toInstance();
  85
  86     private final int STATS_THREAD_EXECUTION_TIME= 50000;
  87     //Local caching of stats
  88
  89     private final ConcurrentMap<NodeId,NodeStatistics> statisticsCache =
  90             new ConcurrentHashMap<NodeId,NodeStatistics>();
  91
  92     public DataProviderService getDataService() {
  93       return this.dps;
  94     }
  95
  96     public void setDataService(final DataProviderService dataService) {
  97       this.dps = dataService;
  98     }
  99
 100     public NotificationProviderService getNotificationService() {
 101       return this.nps;
 102     }
 103
 104     public void setNotificationService(final NotificationProviderService notificationService) {
 105       this.nps = notificationService;
 106     }
 107
 108     public MultipartMessageManager getMultipartMessageManager() {
 109         return multipartMessageManager;
 110     }
 111
 112     private final StatisticsUpdateCommiter updateCommiter = new StatisticsUpdateCommiter(StatisticsProvider.this);
 113
 114     private Registration<NotificationListener> listenerRegistration;
 115
 116     public void start() {
 117
 118         NotificationProviderService nps = this.getNotificationService();
 119         Registration<NotificationListener> registerNotificationListener = nps.registerNotificationListener(this.updateCommiter);
 120         this.listenerRegistration = registerNotificationListener;
 121
 122         // Get Group/Meter statistics service instance
 123         groupStatsService = StatisticsManagerActivator.getProviderContext().
 124                 getRpcService(OpendaylightGroupStatisticsService.class);
 125
 126         meterStatsService = StatisticsManagerActivator.getProviderContext().
 127                 getRpcService(OpendaylightMeterStatisticsService.class);
 128
 129         flowStatsService = StatisticsManagerActivator.getProviderContext().
 130                 getRpcService(OpendaylightFlowStatisticsService.class);
 131
 132         portStatsService = StatisticsManagerActivator.getProviderContext().
 133                 getRpcService(OpendaylightPortStatisticsService.class);
 134
 135         flowTableStatsService = StatisticsManagerActivator.getProviderContext().
 136                 getRpcService(OpendaylightFlowTableStatisticsService.class);
 137
 138         queueStatsService = StatisticsManagerActivator.getProviderContext().
 139                 getRpcService(OpendaylightQueueStatisticsService.class);
 140
 141         statisticsRequesterThread = new Thread( new Runnable(){
 142
 143             @Override
 144             public void run() {
 145                 while(true){
 146                     try {
 147                         statsRequestSender();
 148
 149                         Thread.sleep(STATS_THREAD_EXECUTION_TIME);
 150                     }catch (Exception e){
 151                         spLogger.error("Exception occurred while sending stats request : {}",e);
 152                     }
 153                 }
 154             }
 155         });
 156
 157         spLogger.debug("Statistics requester thread started with timer interval : {}",STATS_THREAD_EXECUTION_TIME);
 158
 159         statisticsRequesterThread.start();
 160
 161         spLogger.info("Statistics Provider started.");
 162     }
 163
 164     protected DataModificationTransaction startChange() {
 165
 166         DataProviderService dps = this.getDataService();
 167         return dps.beginTransaction();
 168     }
 169
 170     private void statsRequestSender(){
 171
 172         List<Node> targetNodes = getAllConnectedNodes();
 173
 174         if(targetNodes == null)
 175             return;
 176
 177
 178         for (Node targetNode : targetNodes){
 179
 180             InstanceIdentifier<Node> targetInstanceId = InstanceIdentifier.builder(Nodes.class).child(Node.class,targetNode.getKey()).toInstance();
 181             NodeRef targetNodeRef = new NodeRef(targetInstanceId);
 182
 183             try {
 184
 185                 sendAggregateFlowsStatsFromAllTablesRequest(targetNode.getKey());
 186
 187                 sendAllFlowsStatsFromAllTablesRequest(targetNodeRef);
 188
 189                 sendAllNodeConnectorsStatisticsRequest(targetNodeRef);
 190
 191                 sendAllFlowTablesStatisticsRequest(targetNodeRef);
 192
 193                 sendAllQueueStatsFromAllNodeConnector (targetNodeRef);
 194
 195             }catch(Exception e){
 196                 spLogger.error("Exception occured while sending statistics requests : {}",e);
 197             }
 198
 199             if(targetNode.getAugmentation(FlowCapableNode.class) != null){
 200
 201                 spLogger.info("Send request for stats collection to node : {})",targetNode.getId());
 202
 203                 try{
 204                   sendAllGroupStatisticsRequest(targetNodeRef);
 205                   sendAllMeterStatisticsRequest(targetNodeRef);
 206                   sendGroupDescriptionRequest(targetNodeRef);
 207                   sendMeterConfigStatisticsRequest(targetNodeRef);
 208                 }catch(Exception e){
 209                     spLogger.error("Exception occured while sending statistics requests : {}", e);
 210                 }
 211             }
 212         }
 213     }
 214
 215     private void sendAllFlowTablesStatisticsRequest(NodeRef targetNodeRef) throws InterruptedException, ExecutionException {
 216         final GetFlowTablesStatisticsInputBuilder input =
 217                 new GetFlowTablesStatisticsInputBuilder();
 218
 219         input.setNode(targetNodeRef);
 220
 221         Future<RpcResult<GetFlowTablesStatisticsOutput>> response =
 222                 flowTableStatsService.getFlowTablesStatistics(input.build());
 223
 224         this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
 225                 , StatsRequestType.ALL_FLOW_TABLE);
 226
 227     }
 228
 229     private void sendAllFlowsStatsFromAllTablesRequest(NodeRef targetNode) throws InterruptedException, ExecutionException{
 230         final GetAllFlowsStatisticsFromAllFlowTablesInputBuilder input =
 231                 new GetAllFlowsStatisticsFromAllFlowTablesInputBuilder();
 232
 233         input.setNode(targetNode);
 234
 235         Future<RpcResult<GetAllFlowsStatisticsFromAllFlowTablesOutput>> response =
 236                 flowStatsService.getAllFlowsStatisticsFromAllFlowTables(input.build());
 237
 238         this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
 239                 , StatsRequestType.ALL_FLOW);
 240
 241     }
 242
 243     private void sendAggregateFlowsStatsFromAllTablesRequest(NodeKey targetNodeKey) throws InterruptedException, ExecutionException{
 244
 245         List<Short> tablesId = getTablesFromNode(targetNodeKey);
 246
 247         if(tablesId.size() != 0){
 248             for(Short id : tablesId){
 249
 250                 spLogger.info("Send aggregate stats request for flow table {} to node {}",id,targetNodeKey);
 251                 GetAggregateFlowStatisticsFromFlowTableForAllFlowsInputBuilder input =
 252                         new GetAggregateFlowStatisticsFromFlowTableForAllFlowsInputBuilder();
 253
 254                 input.setNode(new NodeRef(InstanceIdentifier.builder(Nodes.class).child(Node.class, targetNodeKey).toInstance()));
 255                 input.setTableId(new org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableId(id));
 256                 Future<RpcResult<GetAggregateFlowStatisticsFromFlowTableForAllFlowsOutput>> response =
 257                         flowStatsService.getAggregateFlowStatisticsFromFlowTableForAllFlows(input.build());
 258
 259                 multipartMessageManager.setTxIdAndTableIdMapEntry(response.get().getResult().getTransactionId(), id);
 260                 this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
 261                         , StatsRequestType.AGGR_FLOW);
 262             }
 263         }
 264
 265         //Note: Just for testing, because i am not able to fetch table list from datastore
 266         // Bug-225 is raised for investigation.
 267
 268 //                spLogger.info("Send aggregate stats request for flow table {} to node {}",1,targetNodeKey);
 269 //                GetAggregateFlowStatisticsFromFlowTableForAllFlowsInputBuilder input =
 270 //                        new GetAggregateFlowStatisticsFromFlowTableForAllFlowsInputBuilder();
 271 //
 272 //                input.setNode(new NodeRef(InstanceIdentifier.builder(Nodes.class).child(Node.class, targetNodeKey).toInstance()));
 273 //                input.setTableId(new TableId((short)1));
 274 //                Future<RpcResult<GetAggregateFlowStatisticsFromFlowTableForAllFlowsOutput>> response =
 275 //                        flowStatsService.getAggregateFlowStatisticsFromFlowTableForAllFlows(input.build());`
 276 //
 277 //                multipartMessageManager.setTxIdAndTableIdMapEntry(response.get().getResult().getTransactionId(), (short)1);
 278
 279     }
 280
 281     private void sendAllNodeConnectorsStatisticsRequest(NodeRef targetNode) throws InterruptedException, ExecutionException{
 282
 283         final GetAllNodeConnectorsStatisticsInputBuilder input = new GetAllNodeConnectorsStatisticsInputBuilder();
 284
 285         input.setNode(targetNode);
 286
 287         Future<RpcResult<GetAllNodeConnectorsStatisticsOutput>> response =
 288                 portStatsService.getAllNodeConnectorsStatistics(input.build());
 289         this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
 290                 , StatsRequestType.ALL_PORT);
 291
 292     }
 293
 294     private void sendAllGroupStatisticsRequest(NodeRef targetNode) throws InterruptedException, ExecutionException{
 295
 296         final GetAllGroupStatisticsInputBuilder input = new GetAllGroupStatisticsInputBuilder();
 297
 298         input.setNode(targetNode);
 299
 300         Future<RpcResult<GetAllGroupStatisticsOutput>> response =
 301                 groupStatsService.getAllGroupStatistics(input.build());
 302
 303         this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
 304                 , StatsRequestType.ALL_GROUP);
 305
 306     }
 307
 308     private void sendGroupDescriptionRequest(NodeRef targetNode) throws InterruptedException, ExecutionException{
 309         final GetGroupDescriptionInputBuilder input = new GetGroupDescriptionInputBuilder();
 310
 311         input.setNode(targetNode);
 312
 313         Future<RpcResult<GetGroupDescriptionOutput>> response =
 314                 groupStatsService.getGroupDescription(input.build());
 315
 316         this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
 317                 , StatsRequestType.GROUP_DESC);
 318
 319     }
 320
 321     private void sendAllMeterStatisticsRequest(NodeRef targetNode) throws InterruptedException, ExecutionException{
 322
 323         GetAllMeterStatisticsInputBuilder input = new GetAllMeterStatisticsInputBuilder();
 324
 325         input.setNode(targetNode);
 326
 327         Future<RpcResult<GetAllMeterStatisticsOutput>> response =
 328                 meterStatsService.getAllMeterStatistics(input.build());
 329
 330         this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
 331                 , StatsRequestType.ALL_METER);;
 332
 333     }
 334
 335     private void sendMeterConfigStatisticsRequest(NodeRef targetNode) throws InterruptedException, ExecutionException{
 336
 337         GetAllMeterConfigStatisticsInputBuilder input = new GetAllMeterConfigStatisticsInputBuilder();
 338
 339         input.setNode(targetNode);
 340
 341         Future<RpcResult<GetAllMeterConfigStatisticsOutput>> response =
 342                 meterStatsService.getAllMeterConfigStatistics(input.build());
 343
 344         this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
 345                 , StatsRequestType.METER_CONFIG);;
 346
 347     }
 348
 349     private void sendAllQueueStatsFromAllNodeConnector(NodeRef targetNode) throws InterruptedException, ExecutionException {
 350         GetAllQueuesStatisticsFromAllPortsInputBuilder input = new GetAllQueuesStatisticsFromAllPortsInputBuilder();
 351
 352         input.setNode(targetNode);
 353
 354         Future<RpcResult<GetAllQueuesStatisticsFromAllPortsOutput>> response =
 355                 queueStatsService.getAllQueuesStatisticsFromAllPorts(input.build());
 356
 357         this.multipartMessageManager.addTxIdToRequestTypeEntry(response.get().getResult().getTransactionId()
 358                 , StatsRequestType.ALL_QUEUE_STATS);;
 359
 360     }
 361
 362     public ConcurrentMap<NodeId, NodeStatistics> getStatisticsCache() {
 363         return statisticsCache;
 364     }
 365
 366     private List<Node> getAllConnectedNodes(){
 367
 368         Nodes nodes = (Nodes) dps.readOperationalData(nodesIdentifier);
 369         if(nodes == null)
 370             return null;
 371
 372         spLogger.info("Number of connected nodes : {}",nodes.getNode().size());
 373         return nodes.getNode();
 374     }
 375
 376     private List<Short> getTablesFromNode(NodeKey nodeKey){
 377         InstanceIdentifier<FlowCapableNode> nodesIdentifier = InstanceIdentifier.builder(Nodes.class).child(Node.class,nodeKey).augmentation(FlowCapableNode.class).toInstance();
 378
 379         FlowCapableNode node = (FlowCapableNode)dps.readConfigurationData(nodesIdentifier);
 380         List<Short> tablesId = new ArrayList<Short>();
 381         if(node != null && node.getTable()!=null){
 382             spLogger.info("Number of tables {} supported by node {}",node.getTable().size(),nodeKey);
 383             for(Table table: node.getTable()){
 384                 tablesId.add(table.getId());
 385             }
 386         }
 387         return tablesId;
 388     }
 389
 390     @SuppressWarnings("deprecation")
 391     @Override
 392     public void close(){
 393
 394         try {
 395             spLogger.info("Statistics Provider stopped.");
 396             if (this.listenerRegistration != null) {
 397
 398                 this.listenerRegistration.close();
 399
 400                 this.statisticsRequesterThread.destroy();
 401
 402             }
 403           } catch (Throwable e) {
 404             throw Exceptions.sneakyThrow(e);
 405           }
 406     }
 407
 408 }