org.hawkular.agent.monitor.api

Interface MetricDataPayloadBuilder

All Known Implementing Classes:

MetricDataPayloadBuilderImpl

public interface MetricDataPayloadBuilder

Method Summary

Modifier and Type	Method and Description
void	addDataPoint(String key, long timestamp, double value, org.hawkular.metrics.client.common.MetricType metricType) Add a metric data point.
int	getNumberDataPoints()
String	getTenantId()
void	setTenantId(String tenantId) If the metric data is to be stored with a special tenant ID, this sets that tenant ID.
Object	toPayload()

Method Detail

addDataPoint

void addDataPoint(String key,
                  long timestamp,
                  double value,
                  org.hawkular.metrics.client.common.MetricType metricType)

Add a metric data point. When all metric data points are added, call toPayload() to get the payload message that can be used to send to the storage backend via the storage adapter.

Parameters:

key - identifies the metric

timestamp - the time the metric was collected

value - the value of the metric

metricType - the type of metric

toPayload

Object toPayload()

Returns:

the payload in a format suitable for the storage adapter.

getNumberDataPoints

int getNumberDataPoints()

Returns:

the number of data points that were added to the payload

setTenantId

void setTenantId(String tenantId)

If the metric data is to be stored with a special tenant ID, this sets that tenant ID. If null is passed in, or if this method is not called, the agent's tenant ID is used.

Parameters:

tenantId - the tenant ID to associate the metric data with. May be null.

getTenantId

String getTenantId()

Returns:

the tenant ID to be associated with the metric data. If null, the agent's tenant ID is used.