org.hawkular.alerts.actions.elasticsearch

Class ElasticSearchPlugin

java.lang.Object

org.hawkular.alerts.actions.elasticsearch.ElasticSearchPlugin

All Implemented Interfaces:

ActionPluginListener

public class ElasticSearchPlugin
extends Object
implements ActionPluginListener

Action ElasticSearch Plugin. It processes Actions writing Event/Alerts into an ElasticSearch system. It supports optional JOLT Shiftr transformations to process Events/Alerts into custom JSON formats. i.e. {"tenantId":"tenant", "ctime":"timestamp", "dataId":"dataId","context":"context"} https://github.com/bazaarvoice/jolt/blob/master/jolt-core/src/main/java/com/bazaarvoice/jolt/Shiftr.java

Author:

Jay Shaughnessy, Lucas Ponce

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGIN_NAME
static String	PROP_FORWARDED_FOR "forwarded-for" property is used for X-Forwarded-For HTTP header
static String	PROP_INDEX "index" property is used to indicate the index where the Events/Alerts will be written.
static String	PROP_PASS "pass" property is used as password for Basic credentical authentication
static String	PROP_PROXY_REMOTE_USER "proxy-remote-user" property is used for X-Proxy-Remote-User HTTP header
static String	PROP_TOKEN "token" property is used for Bearer HTTP authentication
static String	PROP_TRANSFORM "transform" defines an optional transformation expression based on JOLT Shiftr format to convert an Event/Alert into a custom JSON format.
static String	PROP_TYPE "type" property is used to define the type under the inxed where the Events/Alerts will be written.
static String	PROP_URL "url" property is used to indicate the ElasticSearch server or servers to connect.
static String	PROP_USER "user" property is used as username for Basic credential authentication

Constructor Summary

Constructors

Constructor and Description
ElasticSearchPlugin()

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getDefaultProperties()
Set<String>	getProperties()
void	process(ActionMessage msg)
protected String	transform(Action a)
protected void	writeAlert(Action a)

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_NAME

public static final String PLUGIN_NAME

See Also:

Constant Field Values

PROP_URL

public static final String PROP_URL

"url" property is used to indicate the ElasticSearch server or servers to connect.

See Also:

Constant Field Values

PROP_INDEX

public static final String PROP_INDEX

"index" property is used to indicate the index where the Events/Alerts will be written.

See Also:

Constant Field Values

PROP_TYPE

public static final String PROP_TYPE

"type" property is used to define the type under the inxed where the Events/Alerts will be written.

See Also:

Constant Field Values

PROP_TRANSFORM

public static final String PROP_TRANSFORM

"transform" defines an optional transformation expression based on JOLT Shiftr format to convert an Event/Alert into a custom JSON format.

See Also:

Constant Field Values

PROP_USER

public static final String PROP_USER

"user" property is used as username for Basic credential authentication

See Also:

Constant Field Values

PROP_PASS

public static final String PROP_PASS

"pass" property is used as password for Basic credentical authentication

See Also:

Constant Field Values

PROP_FORWARDED_FOR

public static final String PROP_FORWARDED_FOR

"forwarded-for" property is used for X-Forwarded-For HTTP header

See Also:

Constant Field Values

PROP_PROXY_REMOTE_USER

public static final String PROP_PROXY_REMOTE_USER

"proxy-remote-user" property is used for X-Proxy-Remote-User HTTP header

See Also:

Constant Field Values

PROP_TOKEN

public static final String PROP_TOKEN

"token" property is used for Bearer HTTP authentication

See Also:

Constant Field Values

Constructor Detail

ElasticSearchPlugin

public ElasticSearchPlugin()

Method Detail

getProperties

public Set<String> getProperties()

Specified by:

getProperties in interface ActionPluginListener

getDefaultProperties

public Map<String,String> getDefaultProperties()

Specified by:

getDefaultProperties in interface ActionPluginListener

process

public void process(ActionMessage msg)
             throws Exception

Specified by:

process in interface ActionPluginListener

Throws:

Exception

transform

protected String transform(Action a)

writeAlert

protected void writeAlert(Action a)
                   throws Exception

Throws:

Exception