net.opentsdb.search

Class SearchPlugin

java.lang.Object

net.opentsdb.search.SearchPlugin

public abstract class SearchPlugin
extends Object

Search plugins allow data from OpenTSDB to be published to a search indexer. Many great products already exist for searching so it doesn't make sense to re-implement an engine within OpenTSDB. Likewise, going directly to the storage system for searching isn't efficient.

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.

Note: Since canonical information is stored in the underlying OpenTSDB database, the same document may be re-indexed more than once. This may happen if someone runs a full re-indexing thread to make sure the search engine is up to date, particularly after a TSD crash where some data may not have been sent. Be sure to account for that when indexing. Each object has a way to uniquely identify it, see the method notes below.

Warning: All indexing methods should be performed asynchronously. You may want to create a queue in the implementation to store data until you can ship it off to the service. Every indexing method should return as quickly as possible.

Since:

2.0

Constructor Summary

Constructors

Constructor and Description
SearchPlugin()

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 com.stumbleupon.async.Deferred<Object>	deleteAnnotation(Annotation note) Called to remove an annotation object from the index Note: Unique Document ID = TSUID and Start Time
abstract com.stumbleupon.async.Deferred<Object>	deleteTSMeta(String tsuid) Called when we need to remove a timeseries meta object from the engine Note: Unique Document ID = TSUID
abstract com.stumbleupon.async.Deferred<Object>	deleteUIDMeta(UIDMeta meta) Called when we need to remove a UID meta object from the engine Note: Unique Document ID = UID and the Type "TYPEUID"
abstract com.stumbleupon.async.Deferred<SearchQuery>	executeQuery(SearchQuery query) Executes a very basic search query, returning the results in the SearchQuery object passed in.
abstract com.stumbleupon.async.Deferred<Object>	indexAnnotation(Annotation note) Indexes an annotation object Note: Unique Document ID = TSUID and Start Time
abstract com.stumbleupon.async.Deferred<Object>	indexTSMeta(TSMeta meta) Indexes a timeseries metadata object in the search engine Note: Unique Document ID = TSUID
abstract com.stumbleupon.async.Deferred<Object>	indexUIDMeta(UIDMeta meta) Indexes a UID metadata object for a metric, tagk or tagv Note: Unique Document ID = UID and the Type "TYPEUID"
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

SearchPlugin

public SearchPlugin()

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

indexTSMeta

public abstract com.stumbleupon.async.Deferred<Object> indexTSMeta(TSMeta meta)

Indexes a timeseries metadata object in the search engine Note: Unique Document ID = TSUID

Parameters:

meta - The TSMeta to index

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>).

deleteTSMeta

public abstract com.stumbleupon.async.Deferred<Object> deleteTSMeta(String tsuid)

Called when we need to remove a timeseries meta object from the engine Note: Unique Document ID = TSUID

Parameters:

tsuid - The hex encoded TSUID to remove

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>).

indexUIDMeta

public abstract com.stumbleupon.async.Deferred<Object> indexUIDMeta(UIDMeta meta)

Indexes a UID metadata object for a metric, tagk or tagv Note: Unique Document ID = UID and the Type "TYPEUID"

Parameters:

meta - The UIDMeta to index

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>).

deleteUIDMeta

public abstract com.stumbleupon.async.Deferred<Object> deleteUIDMeta(UIDMeta meta)

Called when we need to remove a UID meta object from the engine Note: Unique Document ID = UID and the Type "TYPEUID"

Parameters:

meta - The UIDMeta to remove

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>).

indexAnnotation

public abstract com.stumbleupon.async.Deferred<Object> indexAnnotation(Annotation note)

Indexes an annotation object Note: Unique Document ID = TSUID and Start Time

Parameters:

note - The annotation to index

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>).

deleteAnnotation

public abstract com.stumbleupon.async.Deferred<Object> deleteAnnotation(Annotation note)

Called to remove an annotation object from the index Note: Unique Document ID = TSUID and Start Time

Parameters:

note - The annotation to remove

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>).

executeQuery

public abstract com.stumbleupon.async.Deferred<SearchQuery> executeQuery(SearchQuery query)

Executes a very basic search query, returning the results in the SearchQuery object passed in.

Parameters:

query - The query to execute against the search engine

Returns:

The query results