net.opentsdb.tsd

Class RTPublisher

java.lang.Object

net.opentsdb.tsd.RTPublisher

public abstract class RTPublisher
extends Object

Real Time publisher plugin interface that is used to emit data from a TSD as data comes in. Initially it supports publishing data points immediately after they are queued for storage. In the future we may support publishing meta data or other types of information as changes are made.

Note: Implementations must have a parameterless constructor. The initialize(TSDB) method will be called immediately after the plugin is instantiated and before any other methods are called.

Warning: All processing should be performed asynchronously and return a Deferred as quickly as possible.

Since:

2.0

Constructor Summary

Constructors

Constructor and Description
RTPublisher()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	collectStats(StatsCollector collector) Called by the TSD when a request for statistics collection has come in.
abstract void	initialize(TSDB tsdb) Called by TSDB to initialize the plugin Implementations are responsible for setting up any IO they need as well as starting any required background threads.
abstract com.stumbleupon.async.Deferred<Object>	publishAnnotation(Annotation annotation) Called any time a new annotation is published
abstract com.stumbleupon.async.Deferred<Object>	publishDataPoint(String metric, long timestamp, double value, Map<String,String> tags, byte[] tsuid) Called any time a new data point is published
abstract com.stumbleupon.async.Deferred<Object>	publishDataPoint(String metric, long timestamp, long value, Map<String,String> tags, byte[] tsuid) Called any time a new data point is published
abstract com.stumbleupon.async.Deferred<Object>	shutdown() Called to gracefully shutdown the plugin.
com.stumbleupon.async.Deferred<Object>	sinkDataPoint(String metric, long timestamp, byte[] value, Map<String,String> tags, byte[] tsuid, short flags) Called by the TSD when a new, raw data point is published.
abstract String	version() Should return the version of this plugin in the format: MAJOR.MINOR.MAINT, e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

RTPublisher

public RTPublisher()

Method Detail

initialize

public abstract void initialize(TSDB tsdb)

Called by TSDB to initialize the plugin Implementations are responsible for setting up any IO they need as well as starting any required background threads. Note: Implementations should throw exceptions if they can't start up properly. The TSD will then shutdown so the operator can fix the problem. Please use IllegalArgumentException for configuration issues.

Parameters:

tsdb - The parent TSDB object

Throws:

IllegalArgumentException - if required configuration parameters are missing

Exception - if something else goes wrong

shutdown

public abstract com.stumbleupon.async.Deferred<Object> shutdown()

Called to gracefully shutdown the plugin. Implementations should close any IO they have open

Returns:

A deferred object that indicates the completion of the request. The Object has not special meaning and can be null (think of it as Deferred<Void>).

version

public abstract String version()

Should return the version of this plugin in the format: MAJOR.MINOR.MAINT, e.g. 2.0.1. The MAJOR version should match the major version of OpenTSDB the plugin is meant to work with.

Returns:

A version string used to log the loaded version

collectStats

public abstract void collectStats(StatsCollector collector)

Called by the TSD when a request for statistics collection has come in. The implementation may provide one or more statistics. If no statistics are available for the implementation, simply stub the method.

Parameters:

collector - The collector used for emitting statistics

sinkDataPoint

public final com.stumbleupon.async.Deferred<Object> sinkDataPoint(String metric,
                                                   long timestamp,
                                                   byte[] value,
                                                   Map<String,String> tags,
                                                   byte[] tsuid,
                                                   short flags)

Called by the TSD when a new, raw data point is published. Because this is called after a data point is queued, the value has been converted to a byte array so we need to convert it back to an integer or floating point value. Instead of requiring every implementation to perform the calculation we perform it here and let the implementer deal with the integer or float.

Parameters:

metric - The name of the metric associated with the data point

timestamp - Timestamp as a Unix epoch in seconds or milliseconds (depending on the TSD's configuration)

value - The value as a byte array

tags - Tagk/v pairs

tsuid - Time series UID for the value

flags - Indicates if the byte array is an integer or floating point value

Returns:

A deferred without special meaning to wait on if necessary. The value may be null but a Deferred must be returned.

publishDataPoint

public abstract com.stumbleupon.async.Deferred<Object> publishDataPoint(String metric,
                                                      long timestamp,
                                                      long value,
                                                      Map<String,String> tags,
                                                      byte[] tsuid)

Called any time a new data point is published

Parameters:

metric - The name of the metric associated with the data point

timestamp - Timestamp as a Unix epoch in seconds or milliseconds (depending on the TSD's configuration)

value - Value for the data point

tags - Tagk/v pairs

tsuid - Time series UID for the value

Returns:

A deferred without special meaning to wait on if necessary. The value may be null but a Deferred must be returned.

publishDataPoint

public abstract com.stumbleupon.async.Deferred<Object> publishDataPoint(String metric,
                                                      long timestamp,
                                                      double value,
                                                      Map<String,String> tags,
                                                      byte[] tsuid)

Called any time a new data point is published

Parameters:

metric - The name of the metric associated with the data point

timestamp - Timestamp as a Unix epoch in seconds or milliseconds (depending on the TSD's configuration)

value - Value for the data point

tags - Tagk/v pairs

tsuid - Time series UID for the value

Returns:

A deferred without special meaning to wait on if necessary. The value may be null but a Deferred must be returned.

publishAnnotation

public abstract com.stumbleupon.async.Deferred<Object> publishAnnotation(Annotation annotation)

Called any time a new annotation is published

Parameters:

annotation - The published annotation

Returns:

A deferred without special meaning to wait on if necessary. The value may be null but a Deferred must be returned.