org.opendaylight.controller.cluster.common.actor

Class MeteringBehavior

java.lang.Object

org.opendaylight.controller.cluster.common.actor.MeteringBehavior

All Implemented Interfaces:

akka.japi.Procedure<Object>

public class MeteringBehavior
extends Object
implements akka.japi.Procedure<Object>

Represents behaviour that can be exhibited by actors of type UntypedActor

This behaviour meters actor's default behaviour. It captures 2 metrics:

• message processing rate of actor's receive block
• message processing rate by message type

The information is reported to MetricsReporter

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOMAIN

Constructor Summary

Constructors

Constructor and Description
MeteringBehavior(AbstractUntypedActorWithMetering actor) Constructs an instance.
MeteringBehavior(akka.actor.UntypedActor actor)

Method Summary

Modifier and Type	Method and Description
void	apply(Object message) Uses 2 timers to measure message processing rate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DOMAIN

public static final String DOMAIN

See Also:

Constant Field Values

Constructor Detail

MeteringBehavior

public MeteringBehavior(AbstractUntypedActorWithMetering actor)

Constructs an instance.

Parameters:

actor - whose behaviour needs to be metered

MeteringBehavior

public MeteringBehavior(akka.actor.UntypedActor actor)

Method Detail

apply

public void apply(Object message)
           throws Exception

Uses 2 timers to measure message processing rate. One for overall message processing rate and another to measure rate by message type. The timers are re-used if they were previously created.

MetricRegistry maintains a reservoir for different timers where collected timings are kept. It exposes various metrics for each timer based on collected data. Eg: count of messages, 99, 95, 50... percentiles, max, mean etc.

These metrics are exposed as JMX bean.

Specified by:

apply in interface akka.japi.Procedure<Object>

Parameters:

message - the message to process

Throws:

Exception - on message failure

See Also:

http://dropwizard.github.io/metrics/manual/core/#timers