opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/common/actor/MeteringBehavior.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 package org.opendaylight.controller.cluster.common.actor;
   9
  10 import akka.actor.UntypedActor;
  11 import akka.japi.Procedure;
  12 import com.codahale.metrics.MetricRegistry;
  13 import com.codahale.metrics.Timer;
  14 import com.google.common.base.Preconditions;
  15 import org.opendaylight.controller.cluster.reporting.MetricsReporter;
  16
  17 /**
  18  * Represents behaviour that can be exhibited by actors of type {@link akka.actor.UntypedActor}
  19  * <p/>
  20  * This behaviour meters actor's default behaviour. It captures 2 metrics:
  21  * <ul>
  22  *     <li>message processing rate of actor's receive block</li>
  23  *     <li>message processing rate by message type</li>
  24  * </ul>
  25  *
  26  * The information is reported to {@link org.opendaylight.controller.cluster.reporting.MetricsReporter}
  27  */
  28 public class MeteringBehavior implements Procedure<Object> {
  29
  30     private final UntypedActor meteredActor;
  31
  32     private final MetricRegistry METRICREGISTRY = MetricsReporter.getInstance().getMetricsRegistry();
  33     private final String MSG_PROCESSING_RATE = "msg-rate";
  34
  35     private String actorName;
  36     private Timer msgProcessingTimer;
  37
  38     /**
  39      *
  40      * @param actor whose behaviour needs to be metered
  41      */
  42     public MeteringBehavior(UntypedActor actor){
  43         Preconditions.checkArgument(actor != null, "actor must not be null");
  44
  45         this.meteredActor = actor;
  46         actorName = meteredActor.getSelf().path().toStringWithoutAddress();
  47         final String msgProcessingTime = MetricRegistry.name(actorName, MSG_PROCESSING_RATE);
  48         msgProcessingTimer = METRICREGISTRY.timer(msgProcessingTime);
  49     }
  50
  51     /**
  52      * Uses 2 timers to measure message processing rate. One for overall message processing rate and
  53      * another to measure rate by message type. The timers are re-used if they were previously created.
  54      * <p/>
  55      * {@link com.codahale.metrics.MetricRegistry} maintains a reservoir for different timers where
  56      * collected timings are kept. It exposes various metrics for each timer based on collected
  57      * data. Eg: count of messages, 99, 95, 50... percentiles, max, mean etc.
  58      * <p/>
  59      * These metrics are exposed as JMX bean.
  60      *
  61      * @see <a href="http://dropwizard.github.io/metrics/manual/core/#timers">
  62      *     http://dropwizard.github.io/metrics/manual/core/#timers</a>
  63      *
  64      * @param message
  65      * @throws Exception
  66      */
  67     @Override
  68     public void apply(Object message) throws Exception {
  69         final String messageType = message.getClass().getSimpleName();
  70
  71         final String msgProcessingTimeByMsgType =
  72                 MetricRegistry.name(actorName, MSG_PROCESSING_RATE, messageType);
  73
  74         final Timer msgProcessingTimerByMsgType = METRICREGISTRY.timer(msgProcessingTimeByMsgType);
  75
  76         //start timers
  77         final Timer.Context context = msgProcessingTimer.time();
  78         final Timer.Context contextByMsgType = msgProcessingTimerByMsgType.time();
  79
  80         meteredActor.onReceive(message);
  81
  82         //stop timers
  83         contextByMsgType.stop();
  84         context.stop();
  85     }
  86 }