org.hawkular.agent.monitor.api

Interface SamplingService<L>

Type Parameters:

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

All Known Implementing Classes:

DMREndpointService, EndpointService, JMXEndpointService, PlatformEndpointService

public interface SamplingService<L>

A service that can be used to sample metrics and avails for the given MonitoredEndpoint.

Author:

Peter Palaga

Method Summary

Modifier and Type	Method and Description
default 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.
MonitoredEndpoint<MonitorServiceConfiguration.EndpointConfiguration>	getMonitoredEndpoint()
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.

Method Detail

getMonitoredEndpoint

MonitoredEndpoint<MonitorServiceConfiguration.EndpointConfiguration> getMonitoredEndpoint()

Returns:

the endpoint this service is able to sample

generateAssociatedMetricTags

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. The service can use the metric tags provided by the user via the endpoint configuration which contains the metric tags.

Parameters:

instance - the measurement instance whose tags are to be generated

Returns:

the measurement tags to be added to the metric definition

generateAssociatedMetricId

default 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. 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.

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)

measureAvails

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. If the relevant Endpoint is unreachable all instances are reported as Avail.DOWN.

Parameters:

instances - the availabilities to check

consumer - the consumer to send the results to

measureMetrics

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.

Parameters:

instances - the metrics to check

consumer - the consumer to send the results to