net.opentsdb.tsd

Class RpcPlugin

java.lang.Object

net.opentsdb.tsd.RpcPlugin

public abstract class RpcPlugin
extends Object

The RPCPlugin allows for interacting with a TSD using different protocols such as Protobufs, Thrift, Memcache, anything folks want to create. Users may configure one or more optional protocol plugins when starting a TSD. The plugin is responsible for setting up necessary IO in the initialize(net.opentsdb.core.TSDB) method and if there is a problem, such as failure to bind to a socket or missing config options, throw an exception so the user can fix the issue.

Initially this plugin should be used to accept incoming data points. Simply parse the data and call TSDB.addPoint(java.lang.String, long, long, java.util.Map).

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.

Since:

2.0

Constructor Summary

Constructors

Constructor and Description
RpcPlugin()

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>	shutdown() Called to gracefully shutdown the plugin.
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

RpcPlugin

public RpcPlugin()

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