org.hawkular.agent.monitor.protocol

Class EndpointService<L,S extends Session<L>>

java.lang.Object

org.hawkular.agent.monitor.protocol.EndpointService<L,S>

Type Parameters:

L - the type of the protocol specific location, typically a subclass of NodeLocation

S - the protocol specific Session

All Implemented Interfaces:

SamplingService<L>

Direct Known Subclasses:

DMREndpointService, PlatformEndpointService

public abstract class EndpointService<L,S extends Session<L>>
extends Object
implements SamplingService<L>

A service to discover and sample resources from a single MonitoredEndpoint. This service also owns the single ResourceManager associated with the given MonitoredEndpoint.

Author:

Peter Palaga

Field Summary

Fields

Modifier and Type	Field and Description
protected ServiceStatus	status

Constructor Summary

Constructors

Constructor and Description
EndpointService(String feedId, MonitoredEndpoint<MonitorServiceConfiguration.EndpointConfiguration> endpoint, ResourceTypeManager<L> resourceTypeManager, LocationResolver<L> locationResolver, ProtocolDiagnostics diagnostics)

Method Summary

Modifier and Type	Method and Description
void	addInventoryListener(InventoryListener listener) Works only before start() or after stop().
void	discoverAll() Discovers all resources, puts them in the resourceManager, and triggers any listeners listening for new inventory.
boolean	equals(Object obj)
String	generateAssociatedMetricId(MeasurementInstance<L,? extends MeasurementType<L>> instance) Given a measurement instance, this will generate the key to be used when storing that measurement instance's collected data to storage.
Map<String,String>	generateAssociatedMetricTags(MeasurementInstance<L,? extends MeasurementType<L>> instance) Given a measurement instance, this will generate the tags to be added to the associated Hawkular Metrics metric definition.
ProtocolDiagnostics	getDiagnostics()
String	getFeedId()
LocationResolver<L>	getLocationResolver()
MonitoredEndpoint<MonitorServiceConfiguration.EndpointConfiguration>	getMonitoredEndpoint()
ResourceManager<L>	getResourceManager()
ResourceTypeManager<L>	getResourceTypeManager()
int	hashCode()
void	measureAvails(Collection<MeasurementInstance<L,AvailType<L>>> instances, Consumer<AvailDataPoint> consumer) Checks the availabilities defined by instances and reports them back to the given consumer.
void	measureMetrics(Collection<MeasurementInstance<L,MetricType<L>>> instances, Consumer<MetricDataPoint> consumer) Collects the metrics defined by instances and reports them back to the given consumer.
abstract S	openSession() Opens a new protocl specific Session - do not forget to close it!
void	removeInventoryListener(InventoryListener listener) Works only before start() or after stop().
void	removeResources(L location) Remove resources matching the given location and all their direct and indirect descendant resources.
void	start()
void	stop()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

status

protected volatile ServiceStatus status

Constructor Detail

EndpointService

public EndpointService(String feedId,
                       MonitoredEndpoint<MonitorServiceConfiguration.EndpointConfiguration> endpoint,
                       ResourceTypeManager<L> resourceTypeManager,
                       LocationResolver<L> locationResolver,
                       ProtocolDiagnostics diagnostics)

Method Detail

getFeedId

public String getFeedId()

getMonitoredEndpoint

public MonitoredEndpoint<MonitorServiceConfiguration.EndpointConfiguration> getMonitoredEndpoint()

Specified by:

getMonitoredEndpoint in interface SamplingService<L>

Returns:

the endpoint this service is able to sample

getResourceManager

public ResourceManager<L> getResourceManager()

getResourceTypeManager

public ResourceTypeManager<L> getResourceTypeManager()

getLocationResolver

public LocationResolver<L> getLocationResolver()

getDiagnostics

public ProtocolDiagnostics getDiagnostics()

addInventoryListener

public void addInventoryListener(InventoryListener listener)

Works only before start() or after stop().

Parameters:

listener - to add

removeInventoryListener

public void removeInventoryListener(InventoryListener listener)

Works only before start() or after stop().

Parameters:

listener - to remove

openSession

public abstract S openSession()

Opens a new protocl specific Session - do not forget to close it!

Returns:

a new Session

discoverAll

public void discoverAll()

Discovers all resources, puts them in the resourceManager, and triggers any listeners listening for new inventory. This will look for all root resources (resources whose types are that of the root resource types as defined by ResourceTypeManager.getRootResourceTypes() and then obtain all their children (recursively down to all descendents). Effectively, this discovers the full resource hierarchy.

measureAvails

public void measureAvails(Collection<MeasurementInstance<L,AvailType<L>>> instances,
                          Consumer<AvailDataPoint> consumer)

Description copied from interface: SamplingService

Checks the availabilities defined by instances and reports them back to the given consumer. If the relevant Endpoint is unreachable all instances are reported as Avail.DOWN.

Specified by:

measureAvails in interface SamplingService<L>

Parameters:

instances - the availabilities to check

consumer - the consumer to send the results to

measureMetrics

public void measureMetrics(Collection<MeasurementInstance<L,MetricType<L>>> instances,
                           Consumer<MetricDataPoint> consumer)

Description copied from interface: SamplingService

Collects the metrics defined by instances and reports them back to the given consumer.

Specified by:

measureMetrics in interface SamplingService<L>

Parameters:

instances - the metrics to check

consumer - the consumer to send the results to

generateAssociatedMetricId

public String generateAssociatedMetricId(MeasurementInstance<L,? extends MeasurementType<L>> instance)

Description copied from interface: SamplingService

Given a measurement instance, this will generate the key to be used when storing that measurement instance's collected data to storage. In the Hawkular Metrics REST API, this key is known as the "metric id". The service can generate a default one or can use the metric ID template provided by the user via the endpoint configuration which contains a metric ID template. If this method is not implemented, the default behavior is to return the ID of the measurement instance itself.

Specified by:

generateAssociatedMetricId in interface SamplingService<L>

Parameters:

instance - the measurement instance whose key is to be generated

Returns:

the measurement key to be used to identify measured data for the given instance

See Also:

MeasurementInstance#getAssociatedMetricId(String), MeasurementInstance.setAssociatedMetricId(String)

generateAssociatedMetricTags

public Map<String,String> generateAssociatedMetricTags(MeasurementInstance<L,? extends MeasurementType<L>> instance)

Description copied from interface: SamplingService

Given a measurement instance, this will generate the tags to be added to the associated Hawkular Metrics metric definition. The service can use the metric tags provided by the user via the endpoint configuration which contains the metric tags.

Specified by:

generateAssociatedMetricTags in interface SamplingService<L>

Parameters:

instance - the measurement instance whose tags are to be generated

Returns:

the measurement tags to be added to the metric definition

removeResources

public void removeResources(L location)

Remove resources matching the given location and all their direct and indirect descendant resources.

Parameters:

location - a location that can contain wildcards

start

public final void start()

stop

public void stop()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object