org.apache.flink.runtime.metrics.dump

Class MetricQueryService

java.lang.Object

akka.actor.UntypedActor

org.apache.flink.runtime.metrics.dump.MetricQueryService

All Implemented Interfaces:

akka.actor.Actor

public class MetricQueryService
extends akka.actor.UntypedActor

The MetricQueryService creates a key-value representation of all metrics currently registered with Flink when queried.

It is realized as an actor and can be notified of - an added metric by calling notifyOfAddedMetric(ActorRef, Metric, String, AbstractMetricGroup) - a removed metric by calling notifyOfRemovedMetric(ActorRef, Metric) - a metric dump request by sending the return value of getCreateDump()

Nested Class Summary

Nested classes/interfaces inherited from interface akka.actor.Actor

akka.actor.Actor.emptyBehavior$, akka.actor.Actor.ignoringBehavior$

Field Summary

Fields

Modifier and Type	Field and Description
static String	METRIC_QUERY_SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
MetricQueryService(long messageSizeLimit)

Method Summary

Modifier and Type	Method and Description
static Object	getCreateDump()
static void	notifyOfAddedMetric(akka.actor.ActorRef service, org.apache.flink.metrics.Metric metric, String metricName, AbstractMetricGroup group) Utility method to notify a MetricQueryService of an added metric.
static void	notifyOfRemovedMetric(akka.actor.ActorRef service, org.apache.flink.metrics.Metric metric) Utility method to notify a MetricQueryService of a removed metric.
void	onReceive(Object message)
void	postStop()
static akka.actor.ActorRef	startMetricQueryService(akka.actor.ActorSystem actorSystem, ResourceID resourceID, long maximumFramesize) Starts the MetricQueryService actor in the given actor system.

Methods inherited from class akka.actor.UntypedActor

akka$actor$Actor$_setter_$context_$eq, akka$actor$Actor$_setter_$self_$eq, aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, context, getContext, getSelf, getSender, postRestart, preRestart, preStart, receive, self, sender, supervisorStrategy, unhandled

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.actor.Actor

$init$, noSender

Field Detail

METRIC_QUERY_SERVICE_NAME

public static final String METRIC_QUERY_SERVICE_NAME

See Also:

Constant Field Values

Constructor Detail

MetricQueryService

public MetricQueryService(long messageSizeLimit)

Method Detail

postStop

public void postStop()

Specified by:

postStop in interface akka.actor.Actor

Overrides:

postStop in class akka.actor.UntypedActor

onReceive

public void onReceive(Object message)

Specified by:

onReceive in class akka.actor.UntypedActor

startMetricQueryService

public static akka.actor.ActorRef startMetricQueryService(akka.actor.ActorSystem actorSystem,
                                                          ResourceID resourceID,
                                                          long maximumFramesize)

Starts the MetricQueryService actor in the given actor system.

Parameters:

actorSystem - The actor system running the MetricQueryService

resourceID - resource ID to disambiguate the actor name

Returns:

actor reference to the MetricQueryService

notifyOfAddedMetric

public static void notifyOfAddedMetric(akka.actor.ActorRef service,
                                       org.apache.flink.metrics.Metric metric,
                                       String metricName,
                                       AbstractMetricGroup group)

Utility method to notify a MetricQueryService of an added metric.

Parameters:

service - MetricQueryService to notify

metric - added metric

metricName - metric name

group - group the metric was added on

notifyOfRemovedMetric

public static void notifyOfRemovedMetric(akka.actor.ActorRef service,
                                         org.apache.flink.metrics.Metric metric)

Utility method to notify a MetricQueryService of a removed metric.

Parameters:

service - MetricQueryService to notify

metric - removed metric

getCreateDump

public static Object getCreateDump()