org.hawkular.agent.monitor.api

Interface MetricTagPayloadBuilder

All Known Implementing Classes:

MetricTagPayloadBuilderImpl

public interface MetricTagPayloadBuilder

Method Summary

Modifier and Type	Method and Description
void	addTag(String key, String name, String value, org.hawkular.metrics.client.common.MetricType metricType) Add a tag to a metric type.
int	getNumberTags()
String	getTenantId()
void	setTenantId(String tenantId) If the metric tags are to be stored with a special tenant ID, this sets that tenant ID.
Map<String,String>	toPayload() Due to the way Hawkular Metrics REST API works, you can only add tags for a single metric.

Method Detail

addTag

void addTag(String key,
            String name,
            String value,
            org.hawkular.metrics.client.common.MetricType metricType)

Add a tag to a metric type. When all metric tags 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

name - the name of the tag

value - the value of the tag

metricType - the type of metric

toPayload

Map<String,String> toPayload()

Due to the way Hawkular Metrics REST API works, you can only add tags for a single metric. So this method actually has the potential to return mulitple payloads - one for each metric that is getting assigned tags. The key to the map is the relative path to the REST API that identifies the metric whose tags are being added. For example, if a gauge metric of id "foo" is getting tags, its key in the map will be "gauges/foo". The values of the map are the JSON encodings of all the tags for the metric.

Returns:

the payloads in a format suitable for the storage adapter.

getNumberTags

int getNumberTags()

Returns:

the number of tags that were added to payload

setTenantId

void setTenantId(String tenantId)

If the metric tags are 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 tags with. May be null.

getTenantId

String getTenantId()

Returns:

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