opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/common/actor/MeteredBoundedMailbox.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  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
   9 package org.opendaylight.controller.cluster.common.actor;
  10
  11 import akka.actor.ActorRef;
  12 import akka.actor.ActorSystem;
  13 import akka.dispatch.BoundedDequeBasedMailbox;
  14 import akka.dispatch.MailboxType;
  15 import akka.dispatch.ProducesMessageQueue;
  16 import com.codahale.metrics.Gauge;
  17 import com.codahale.metrics.MetricRegistry;
  18 import com.typesafe.config.Config;
  19 import org.opendaylight.controller.cluster.reporting.MetricsReporter;
  20 import org.slf4j.Logger;
  21 import org.slf4j.LoggerFactory;
  22 import scala.concurrent.duration.FiniteDuration;
  23
  24 public class MeteredBoundedMailbox implements MailboxType,
  25         ProducesMessageQueue<MeteredBoundedMailbox.MeteredMessageQueue> {
  26     private static final Logger LOG = LoggerFactory.getLogger(MeteredBoundedMailbox.class);
  27     private static final String QUEUE_SIZE = "q-size";
  28
  29     private final Integer capacity;
  30     private final FiniteDuration pushTimeOut;
  31     private final MetricRegistry registry;
  32
  33     public MeteredBoundedMailbox(ActorSystem.Settings settings, Config config) {
  34
  35         CommonConfig commonConfig = new CommonConfig(settings.config());
  36         this.capacity = commonConfig.getMailBoxCapacity();
  37         this.pushTimeOut = commonConfig.getMailBoxPushTimeout();
  38
  39         MetricsReporter reporter = MetricsReporter.getInstance(MeteringBehavior.DOMAIN);
  40         registry = reporter.getMetricsRegistry();
  41     }
  42
  43
  44     @Override
  45     public MeteredMessageQueue create(final scala.Option<ActorRef> owner, scala.Option<ActorSystem> system) {
  46         final MeteredMessageQueue queue = new MeteredMessageQueue(this.capacity, this.pushTimeOut);
  47         monitorQueueSize(owner, queue);
  48         return queue;
  49     }
  50
  51     private void monitorQueueSize(scala.Option<ActorRef> owner, final MeteredMessageQueue monitoredQueue) {
  52         if (owner.isEmpty()) {
  53             return; //there's no actor to monitor
  54         }
  55         String actorName = owner.get().path().toStringWithoutAddress();
  56         String metricName = MetricRegistry.name(actorName, QUEUE_SIZE);
  57
  58         if (registry.getMetrics().containsKey(metricName)) {
  59             return; //already registered
  60         }
  61
  62         Gauge<Integer> queueSize = getQueueSizeGuage(monitoredQueue);
  63         registerQueueSizeMetric(metricName, queueSize);
  64     }
  65
  66
  67     public static class MeteredMessageQueue extends BoundedDequeBasedMailbox.MessageQueue {
  68         private static final long serialVersionUID = 1L;
  69
  70         public MeteredMessageQueue(int capacity, FiniteDuration pushTimeOut) {
  71             super(capacity, pushTimeOut);
  72         }
  73     }
  74
  75     private static Gauge<Integer> getQueueSizeGuage(final MeteredMessageQueue monitoredQueue) {
  76         return () -> monitoredQueue.size();
  77     }
  78
  79     private void registerQueueSizeMetric(String metricName, Gauge<Integer> metric) {
  80         try {
  81             registry.register(metricName,metric);
  82         } catch (IllegalArgumentException e) {
  83             LOG.warn("Unable to register queue size in metrics registry. Failed with exception {}. ", e);
  84         }
  85     }
  86 }
  87