org.apache.flume.interceptor

Class SearchAndReplaceInterceptor

java.lang.Object

org.apache.flume.interceptor.SearchAndReplaceInterceptor

All Implemented Interfaces:

Interceptor

public class SearchAndReplaceInterceptor
extends Object
implements Interceptor

Interceptor that allows search-and-replace of event body strings using regular expressions. This only works with event bodies that are valid strings. The charset is configurable.

Usage:

   agent.source-1.interceptors.search-replace.searchPattern = ^INFO:
   agent.source-1.interceptors.search-replace.replaceString = Log msg:
 

Any regular expression search pattern and replacement pattern that can be used with Matcher.replaceAll(String) may be used, including backtracking and grouping.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchAndReplaceInterceptor.Builder

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Perform any closing / shutdown needed by the Interceptor.
void	initialize() Any initialization / startup needed by the Interceptor.
Event	intercept(Event event) Interception of a single Event.
List<Event>	intercept(List<Event> events) Interception of a batch of events.

Methods inherited from class java.lang.Object

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

Method Detail

initialize

public void initialize()

Description copied from interface: Interceptor

Any initialization / startup needed by the Interceptor.

Specified by:

initialize in interface Interceptor

close

public void close()

Description copied from interface: Interceptor

Perform any closing / shutdown needed by the Interceptor.

Specified by:

close in interface Interceptor

intercept

public Event intercept(Event event)

Description copied from interface: Interceptor

Interception of a single Event.

Specified by:

intercept in interface Interceptor

Parameters:

event - Event to be intercepted

Returns:

Original or modified event, or null if the Event is to be dropped (i.e. filtered out).

intercept

public List<Event> intercept(List<Event> events)

Description copied from interface: Interceptor

Interception of a batch of events.

Specified by:

intercept in interface Interceptor

Parameters:

events - Input list of events

Returns:

Output list of events. The size of output list MUST NOT BE GREATER than the size of the input list (i.e. transformation and removal ONLY). Also, this method MUST NOT return null. If all events are dropped, then an empty List is returned.