com.netflix.turbine.monitor.cluster

Class ClusterMonitor<K extends TurbineData>

java.lang.Object

com.netflix.turbine.monitor.TurbineDataMonitor<K>

com.netflix.turbine.monitor.cluster.ClusterMonitor<K>

Type Parameters:

K -

Direct Known Subclasses:

AggregateClusterMonitor

public abstract class ClusterMonitor<K extends TurbineData>
extends TurbineDataMonitor<K>

A class that represents a TurbineDataMonitor for a cluster of Instances.

The ClusterMonitor exhibits functionality that can be used for any extending class to manage it's respective InstanceMonitors as Instances go up and down in a dynamic environment and ensure that they receive data from the most up to date set of hosts.

This includes

• Managing all InstanceMonitors in the MonitorConsole to help keep InstanceMonitor start idempotent
• Starting new InstanceMonitors as new Instances appear - maybe due to a deployment or a new autoscale event etc.
• Stopping the InstanceMonitors for Instances that are marked as down or have been terminated.
• Notifying handlers below when it stops so that they can tear down appropriately.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ClusterMonitor.ClusterMonitorInstanceManager Helper class that responds to hostup and hostdown events and thus can start / stop InstanceMonitors
static class	ClusterMonitor.UnitTest

Field Summary

Fields

Modifier and Type	Field and Description
protected MonitorConsole<K>	clusterConsole
protected TurbineDataDispatcher<K>	clusterDispatcher
protected MonitorConsole<DataFromSingleInstance>	hostConsole
protected TurbineDataDispatcher<DataFromSingleInstance>	hostDispatcher
protected InstanceObservable	instanceObservable
protected InstanceObservable.InstanceObserver	monitorManager
protected java.lang.String	name
protected Instance	statsInstance
protected boolean	stopped
protected InstanceUrlClosure	urlClosure

Constructor Summary

Constructors

Modifier	Constructor and Description
	ClusterMonitor(java.lang.String name, TurbineDataDispatcher<K> clusterDispatcher, MonitorConsole<K> clusterConsole, TurbineDataDispatcher<DataFromSingleInstance> hostDispatcher, MonitorConsole<DataFromSingleInstance> hostConsole, InstanceUrlClosure urlClosure)
protected	ClusterMonitor(java.lang.String name, TurbineDataDispatcher<K> cDispatcher, MonitorConsole<K> cConsole, TurbineDataDispatcher<DataFromSingleInstance> hDispatcher, MonitorConsole<DataFromSingleInstance> hConsole, InstanceUrlClosure urlClosure, InstanceObservable instanceObservable)

Method Summary

Methods

Modifier and Type	Method and Description
TurbineDataDispatcher<K>	getDispatcher()
abstract TurbineDataHandler<DataFromSingleInstance>	getEventHandler() To be implemented by extending cluster monitors such as the aggregator.
int	getHostCount()
MonitorConsole<DataFromSingleInstance>	getInstanceMonitors()
protected MetaInformation<K>	getMetaInformation() Track meta info for this cluster.
java.lang.String	getName()
abstract ObservationCriteria	getObservationCriteria()
Instance	getStatsInstance()
boolean	isRunning()
void	registerListenertoClusterMonitor(TurbineDataHandler<K> eventHandler) Helper method that registers a listener to this cluster monitor.
void	startMonitor() Start the monitor and register with the InstanceObservable to get updates on host status
void	stopMonitor() Stop the monitor, shut down resources that were created and notify listeners downstream about the event.

Methods inherited from class com.netflix.turbine.monitor.TurbineDataMonitor

getEventDiscarded, getEventProcessed, getLastEventUpdateTime, getRolling2MinuteStats, markEventDiscarded, markEventProcessed

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final java.lang.String name

clusterDispatcher

protected final TurbineDataDispatcher<K extends TurbineData> clusterDispatcher

clusterConsole

protected final MonitorConsole<K extends TurbineData> clusterConsole

hostDispatcher

protected final TurbineDataDispatcher<DataFromSingleInstance> hostDispatcher

hostConsole

protected final MonitorConsole<DataFromSingleInstance> hostConsole

stopped

protected volatile boolean stopped

statsInstance

protected final Instance statsInstance

instanceObservable

protected final InstanceObservable instanceObservable

urlClosure

protected final InstanceUrlClosure urlClosure

monitorManager

protected final InstanceObservable.InstanceObserver monitorManager

Constructor Detail

ClusterMonitor

public ClusterMonitor(java.lang.String name,
              TurbineDataDispatcher<K> clusterDispatcher,
              MonitorConsole<K> clusterConsole,
              TurbineDataDispatcher<DataFromSingleInstance> hostDispatcher,
              MonitorConsole<DataFromSingleInstance> hostConsole,
              InstanceUrlClosure urlClosure)

Parameters:

name -

clusterDispatcher - : the dispatcher to dispatch cluster events to - e.g aggregated events

clusterConsole - : the console to register itself with, so that it can be discoverd by other listeners to cluster data

hostDispatcher - : the dispatcher to receive host events from

hostConsole - : the host console to maintain host connections in.

urlClosure - : the config dictating how to connect to a host.

ClusterMonitor

protected ClusterMonitor(java.lang.String name,
              TurbineDataDispatcher<K> cDispatcher,
              MonitorConsole<K> cConsole,
              TurbineDataDispatcher<DataFromSingleInstance> hDispatcher,
              MonitorConsole<DataFromSingleInstance> hConsole,
              InstanceUrlClosure urlClosure,
              InstanceObservable instanceObservable)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in class TurbineDataMonitor<K extends TurbineData>

Returns:

String

getStatsInstance

public Instance getStatsInstance()

Specified by:

getStatsInstance in class TurbineDataMonitor<K extends TurbineData>

Returns:

Instance

startMonitor

public void startMonitor()
                  throws java.lang.Exception

Start the monitor and register with the InstanceObservable to get updates on host status

Specified by:

startMonitor in class TurbineDataMonitor<K extends TurbineData>

Throws:

java.lang.Exception

stopMonitor

public void stopMonitor()

Stop the monitor, shut down resources that were created and notify listeners downstream about the event.

Specified by:

stopMonitor in class TurbineDataMonitor<K extends TurbineData>

getInstanceMonitors

public MonitorConsole<DataFromSingleInstance> getInstanceMonitors()

Returns:

MonitorConsole<DataFromSingleInstance>

getHostCount

@Monitor(name="hostCount",
         type=GAUGE)
public int getHostCount()

isRunning

public boolean isRunning()

getDispatcher

public TurbineDataDispatcher<K> getDispatcher()

Specified by:

getDispatcher in class TurbineDataMonitor<K extends TurbineData>

Returns:

TurbineDataDispatcher

getEventHandler

public abstract TurbineDataHandler<DataFromSingleInstance> getEventHandler()

To be implemented by extending cluster monitors such as the aggregator.

Returns:

TurbineDataHandler<DataFromSingleInstance>

getObservationCriteria

public abstract ObservationCriteria getObservationCriteria()

Returns:

ObservationCriteria

registerListenertoClusterMonitor

public void registerListenertoClusterMonitor(TurbineDataHandler<K> eventHandler)

Helper method that registers a listener to this cluster monitor.

Parameters:

eventHandler -

getMetaInformation

protected MetaInformation<K> getMetaInformation()

Track meta info for this cluster. This feature is optional. Do not override if you don't want meta info from your cluster monitor. One can set the config property 'turbine.MetaInfoUpdator.enabled' to value 'false' to turn off the updator as well.

Returns: