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 MeteredMessageQueue queue;
  30     private final Integer capacity;
  31     private final FiniteDuration pushTimeOut;
  32     private final MetricRegistry registry;
  33
  34     public MeteredBoundedMailbox(ActorSystem.Settings settings, Config config) {
  35
  36         CommonConfig commonConfig = new CommonConfig(settings.config());
  37         this.capacity = commonConfig.getMailBoxCapacity();
  38         this.pushTimeOut = commonConfig.getMailBoxPushTimeout();
  39
  40         MetricsReporter reporter = MetricsReporter.getInstance(MeteringBehavior.DOMAIN);
  41         registry = reporter.getMetricsRegistry();
  42     }
  43
  44
  45     @Override
  46     public MeteredMessageQueue create(final scala.Option<ActorRef> owner, scala.Option<ActorSystem> system) {
  47         this.queue = new MeteredMessageQueue(this.capacity, this.pushTimeOut);
  48         monitorQueueSize(owner, this.queue);
  49         return this.queue;
  50     }
  51
  52     private void monitorQueueSize(scala.Option<ActorRef> owner, final MeteredMessageQueue monitoredQueue) {
  53         if (owner.isEmpty()) {
  54             return; //there's no actor to monitor
  55         }
  56         String actorName = owner.get().path().toStringWithoutAddress();
  57         String metricName = MetricRegistry.name(actorName, QUEUE_SIZE);
  58
  59         if (registry.getMetrics().containsKey(metricName)) {
  60             return; //already registered
  61         }
  62
  63         Gauge<Integer> queueSize = getQueueSizeGuage(monitoredQueue);
  64         registerQueueSizeMetric(metricName, queueSize);
  65     }
  66
  67
  68     public static class MeteredMessageQueue extends BoundedDequeBasedMailbox.MessageQueue {
  69         private static final long serialVersionUID = 1L;
  70
  71         public MeteredMessageQueue(int capacity, FiniteDuration pushTimeOut) {
  72             super(capacity, pushTimeOut);
  73         }
  74     }
  75
  76     private static Gauge<Integer> getQueueSizeGuage(final MeteredMessageQueue monitoredQueue) {
  77         return () -> monitoredQueue.size();
  78     }
  79
  80     private void registerQueueSizeMetric(String metricName, Gauge<Integer> metric) {
  81         try {
  82             registry.register(metricName,metric);
  83         } catch (IllegalArgumentException e) {
  84             LOG.warn("Unable to register queue size in metrics registry. Failed with exception {}. ", e);
  85         }
  86     }
  87 }
  88