org.elasticsearch.hadoop.handler.impl.elasticsearch

Class ElasticsearchHandler<I extends Exceptional,O,C extends ErrorCollector<O>>

java.lang.Object

org.elasticsearch.hadoop.handler.impl.elasticsearch.ElasticsearchHandler<I,O,C>

Type Parameters:

I - type of error event

O - in case of retries, this is the type of the retry value

C - the type of error collector used

All Implemented Interfaces:

ErrorHandler<I,O,C>

public class ElasticsearchHandler<I extends Exceptional,O,C extends ErrorCollector<O>>
extends java.lang.Object
implements ErrorHandler<I,O,C>

Generic Error Handler that converts error events into JSON documents, and stores them in an Elasticsearch index.

Handler results returned from this handler are configurable; In the case that the event is successfully written to Elasticsearch it returns HANDLED by default and if the event cannot be written for any reason it returns ABORT by default.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONF_CLIENT_CONF
static java.lang.String	CONF_CLIENT_INHERIT
static java.lang.String	CONF_CLIENT_NODES
static java.lang.String	CONF_CLIENT_PORT
static java.lang.String	CONF_CLIENT_RESOURCE
static java.lang.String	CONF_LABEL
static java.lang.String	CONF_PASS_REASON_SUFFIX
static java.lang.String	CONF_RETURN_ERROR
static java.lang.String	CONF_RETURN_ERROR_DEFAULT
static java.lang.String	CONF_RETURN_VALUE
static java.lang.String	CONF_RETURN_VALUE_DEFAULT
static java.lang.String	CONF_TAGS

Constructor Summary

Constructors

Constructor and Description
ElasticsearchHandler(Settings rootSettings, EventConverter<I> eventConverter)

Method Summary

Modifier and Type	Method and Description
void	close() Called at the close of the connector to clean up any internal resources.
static <I extends Exceptional,O,C extends ErrorCollector<O>> ElasticsearchHandler<I,O,C>	create(Settings rootSettings, EventConverter<I> converter)
void	init(java.util.Properties properties) Called at the handler creation time to initialize any internal state or resources.
HandlerResult	onError(I entry, C collector) Called when an exception or failure occurs in a part of the connector.

Methods inherited from class java.lang.Object

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

Field Detail

CONF_RETURN_VALUE

public static final java.lang.String CONF_RETURN_VALUE

See Also:

Constant Field Values

CONF_RETURN_VALUE_DEFAULT

public static final java.lang.String CONF_RETURN_VALUE_DEFAULT

CONF_RETURN_ERROR

public static final java.lang.String CONF_RETURN_ERROR

See Also:

Constant Field Values

CONF_RETURN_ERROR_DEFAULT

public static final java.lang.String CONF_RETURN_ERROR_DEFAULT

CONF_PASS_REASON_SUFFIX

public static final java.lang.String CONF_PASS_REASON_SUFFIX

See Also:

Constant Field Values

CONF_LABEL

public static final java.lang.String CONF_LABEL

See Also:

Constant Field Values

CONF_TAGS

public static final java.lang.String CONF_TAGS

See Also:

Constant Field Values

CONF_CLIENT_NODES

public static final java.lang.String CONF_CLIENT_NODES

See Also:

Constant Field Values

CONF_CLIENT_PORT

public static final java.lang.String CONF_CLIENT_PORT

See Also:

Constant Field Values

CONF_CLIENT_RESOURCE

public static final java.lang.String CONF_CLIENT_RESOURCE

See Also:

Constant Field Values

CONF_CLIENT_INHERIT

public static final java.lang.String CONF_CLIENT_INHERIT

See Also:

Constant Field Values

CONF_CLIENT_CONF

public static final java.lang.String CONF_CLIENT_CONF

See Also:

Constant Field Values

Constructor Detail

ElasticsearchHandler

public ElasticsearchHandler(Settings rootSettings,
                            EventConverter<I> eventConverter)

Method Detail

create

public static <I extends Exceptional,O,C extends ErrorCollector<O>> ElasticsearchHandler<I,O,C> create(Settings rootSettings,
                                                                                                       EventConverter<I> converter)

init

public void init(java.util.Properties properties)

Description copied from interface: ErrorHandler

Called at the handler creation time to initialize any internal state or resources.

Specified by:

init in interface ErrorHandler<I extends Exceptional,O,C extends ErrorCollector<O>>

Parameters:

properties - Properties for this handler with handler name prefix stripped away.

onError

public HandlerResult onError(I entry,
                             C collector)
                      throws java.lang.Exception

Description copied from interface: ErrorHandler

Called when an exception or failure occurs in a part of the connector.

Specified by:

onError in interface ErrorHandler<I extends Exceptional,O,C extends ErrorCollector<O>>

Parameters:

entry - information about the failure, normally includes operational data and error information

collector - handler for accepting user reactions to the failure, like retrying with modified parameters

Returns:

An enum that describes the handler's result, either that it handled the error or if the error should be passed on to the next handler.

Throws:

java.lang.Exception - In the event that the current failure should not be handled, and should halt the connector processing.

close

public void close()

Description copied from interface: ErrorHandler

Called at the close of the connector to clean up any internal resources.

Specified by:

close in interface ErrorHandler<I extends Exceptional,O,C extends ErrorCollector<O>>