2 * Copyright (c) 2014 Cisco Systems, Inc. and others. 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.cluster.common.actor;
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;
18 * Represents behaviour that can be exhibited by actors of type {@link akka.actor.UntypedActor}
20 * This behaviour meters actor's default behaviour. It captures 2 metrics:
22 * <li>message processing rate of actor's receive block</li>
23 * <li>message processing rate by message type</li>
26 * The information is reported to {@link org.opendaylight.controller.cluster.reporting.MetricsReporter}
28 public class MeteringBehavior implements Procedure<Object> {
30 private final UntypedActor meteredActor;
32 private final MetricRegistry METRICREGISTRY = MetricsReporter.getInstance().getMetricsRegistry();
33 private final String MSG_PROCESSING_RATE = "msg-rate";
35 private String actorQualifiedName;
36 private Timer msgProcessingTimer;
40 * @param actor whose behaviour needs to be metered
42 public MeteringBehavior(AbstractUntypedActorWithMetering actor){
43 Preconditions.checkArgument(actor != null, "actor must not be null");
44 this.meteredActor = actor;
46 String actorName = actor.getActorNameOverride() != null ? actor.getActorNameOverride()
47 : actor.getSelf().path().name();
51 public MeteringBehavior(UntypedActor actor){
52 Preconditions.checkArgument(actor != null, "actor must not be null");
53 this.meteredActor = actor;
55 String actorName = actor.getSelf().path().name();
59 private void init(String actorName){
60 actorQualifiedName = new StringBuilder(meteredActor.getSelf().path().parent().toStringWithoutAddress()).
61 append("/").append(actorName).toString();
63 final String msgProcessingTime = MetricRegistry.name(actorQualifiedName, MSG_PROCESSING_RATE);
64 msgProcessingTimer = METRICREGISTRY.timer(msgProcessingTime);
68 * Uses 2 timers to measure message processing rate. One for overall message processing rate and
69 * another to measure rate by message type. The timers are re-used if they were previously created.
71 * {@link com.codahale.metrics.MetricRegistry} maintains a reservoir for different timers where
72 * collected timings are kept. It exposes various metrics for each timer based on collected
73 * data. Eg: count of messages, 99, 95, 50... percentiles, max, mean etc.
75 * These metrics are exposed as JMX bean.
77 * @see <a href="http://dropwizard.github.io/metrics/manual/core/#timers">
78 * http://dropwizard.github.io/metrics/manual/core/#timers</a>
84 public void apply(Object message) throws Exception {
85 final String messageType = message.getClass().getSimpleName();
87 final String msgProcessingTimeByMsgType =
88 MetricRegistry.name(actorQualifiedName, MSG_PROCESSING_RATE, messageType);
90 final Timer msgProcessingTimerByMsgType = METRICREGISTRY.timer(msgProcessingTimeByMsgType);
93 final Timer.Context context = msgProcessingTimer.time();
94 final Timer.Context contextByMsgType = msgProcessingTimerByMsgType.time();
96 meteredActor.onReceive(message);
99 contextByMsgType.stop();