org.hawkular.agent.monitor.scheduler

Class MeasurementScheduler<L,T extends MeasurementType<L>,D extends DataPoint>

java.lang.Object

org.hawkular.agent.monitor.scheduler.MeasurementScheduler<L,T,D>

Type Parameters:

T - the sublclass of MeasurementType to handle (such as metric types or avail types)

D - the DataPoint type (such as metric data or avail data)

public abstract class MeasurementScheduler<L,T extends MeasurementType<L>,D extends DataPoint>
extends Object

A scheduler that can be used to collect metrics or availability. To create a scheduler, use one of #forMetrics(String, int, Consumer) or #forAvails(String, int, Consumer).

Field Summary

Fields

Modifier and Type	Field and Description
protected ServiceStatus	status lifecycle status of the scheduler itself

Method Summary

Modifier and Type	Method and Description
protected abstract Runnable	createCollector(SamplingService<L> endpointService, ScheduledCollectionsQueue<L,T> queue, Consumer<D> completionHandler) Creates the object that will be responsible for collecting the data;
static <LL> MeasurementScheduler<LL,AvailType<LL>,AvailDataPoint>	forAvails(String name, Consumer<AvailDataPoint> completionHandler) Static method that builds a scheduler for availability checking.
static <LL> MeasurementScheduler<LL,MetricType<LL>,MetricDataPoint>	forMetrics(String name, Consumer<MetricDataPoint> completionHandler) Static method that builds a scheduler for metric collection.
protected abstract Collection<ScheduledMeasurementInstance<L,T>>	getScheduledMeasurementInstances(Resource<L> resource) Given a resource, this returns the measurement instances that this scheduler should collect for it.
void	schedule(SamplingService<L> endpointService, Collection<Resource<L>> resources) Schedules collections for all measurements for the given resources.
void	start()
void	stop()
void	unschedule(SamplingService<L> endpointService, Collection<Resource<L>> resources) Removes any existing collections that are scheduled for the given resources.

Methods inherited from class java.lang.Object

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

Field Detail

status

protected volatile ServiceStatus status

lifecycle status of the scheduler itself

Method Detail

forMetrics

public static <LL> MeasurementScheduler<LL,MetricType<LL>,MetricDataPoint> forMetrics(String name,
                                                                                      Consumer<MetricDataPoint> completionHandler)

Static method that builds a scheduler for metric collection.

Parameters:

name - the name of the scheduler (used for things like naming the threads)

completionHandler - object that is notified of metric values when they are collected

Returns:

the new metric collection scheduler

forAvails

public static <LL> MeasurementScheduler<LL,AvailType<LL>,AvailDataPoint> forAvails(String name,
                                                                                   Consumer<AvailDataPoint> completionHandler)

Static method that builds a scheduler for availability checking.

Parameters:

name - the name of the scheduler (used for things like naming the threads)

completionHandler - object that is notified of availability results when they are checked

Returns:

the new availability checking scheduler

schedule

public void schedule(SamplingService<L> endpointService,
                     Collection<Resource<L>> resources)

Schedules collections for all measurements for the given resources.

Parameters:

endpointService - defines where the resources are

resources - the resources whose metric collections/avail checks are to be added to the scheduler

unschedule

public void unschedule(SamplingService<L> endpointService,
                       Collection<Resource<L>> resources)

Removes any existing collections that are scheduled for the given resources.

Parameters:

endpointService - defines where the resources are

resources - the resources whose metric collections/avail checks are to be removed from the scheduler

start

public void start()

stop

public void stop()

createCollector

protected abstract Runnable createCollector(SamplingService<L> endpointService,
                                            ScheduledCollectionsQueue<L,T> queue,
                                            Consumer<D> completionHandler)

Creates the object that will be responsible for collecting the data;

Parameters:

endpointService - the resources whose data is to be collected are managed by this endpoint

queue - contains the scheduled measurements

completionHandler - handler to process the measurement collection results

Returns:

the collector object

getScheduledMeasurementInstances

protected abstract Collection<ScheduledMeasurementInstance<L,T>> getScheduledMeasurementInstances(Resource<L> resource)

Given a resource, this returns the measurement instances that this scheduler should collect for it. This does NOT return the currently scheduled measurements - this returns a set of collections that can be used to add to the scheduler in order to begin collecting them.

Parameters:

resource - the resource whose measurement instances are to be returned

Returns:

the measurement instances that need to be collected for this resource