org.springframework.boot.actuate.metrics.opentsdb

Class OpenTsdbMetricWriter

java.lang.Object

org.springframework.boot.actuate.metrics.opentsdb.OpenTsdbMetricWriter

All Implemented Interfaces:

MetricWriter

public class OpenTsdbMetricWriter
extends Object
implements MetricWriter

A MetricWriter for the Open TSDB database (version 2.0), writing metrics to the HTTP endpoint provided by the server. Data are buffered according to the bufferSize property, and only flushed automatically when the buffer size is reached. Users should either manually flush() after writing a batch of data if that makes sense, or consider adding a Scheduled task to flush periodically.

Since:

1.3.0

Author:

Dave Syer

Constructor Summary

Constructors

Constructor and Description
OpenTsdbMetricWriter()

Method Summary

Modifier and Type	Method and Description
void	flush() Flush the buffer without waiting for it to fill any further.
RestOperations	getRestTemplate()
void	increment(Delta<?> delta) Increment the value of a metric (or decrement if the delta is negative).
void	reset(String metricName) Reset the value of a metric, usually to zero value.
void	set(Metric<?> value) Set the value of a metric.
void	setBufferSize(int bufferSize)
void	setMediaType(MediaType mediaType)
void	setNamingStrategy(OpenTsdbNamingStrategy namingStrategy)
void	setRestTemplate(RestOperations restTemplate)
void	setUrl(String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenTsdbMetricWriter

public OpenTsdbMetricWriter()

Method Detail

getRestTemplate

public RestOperations getRestTemplate()

setRestTemplate

public void setRestTemplate(RestOperations restTemplate)

setUrl

public void setUrl(String url)

setBufferSize

public void setBufferSize(int bufferSize)

setMediaType

public void setMediaType(MediaType mediaType)

setNamingStrategy

public void setNamingStrategy(OpenTsdbNamingStrategy namingStrategy)

increment

public void increment(Delta<?> delta)

Description copied from interface: MetricWriter

Increment the value of a metric (or decrement if the delta is negative). The name of the delta is the name of the metric to increment.

Specified by:

increment in interface MetricWriter

Parameters:

delta - the amount to increment by

set

public void set(Metric<?> value)

Description copied from interface: MetricWriter

Set the value of a metric.

Specified by:

set in interface MetricWriter

Parameters:

value - the value

flush

public void flush()

Flush the buffer without waiting for it to fill any further.

reset

public void reset(String metricName)

Description copied from interface: MetricWriter

Reset the value of a metric, usually to zero value. Implementations can discard the old values if desired, but may choose not to.

Specified by:

reset in interface MetricWriter

Parameters:

metricName - the name to reset