Package org.graylog2.plugin.inputs
Class Extractor
java.lang.Object
org.graylog2.plugin.inputs.Extractor
- All Implemented Interfaces:
EmbeddedPersistable
- Direct Known Subclasses:
CopyInputExtractor
,GrokExtractor
,JsonExtractor
,LookupTableExtractor
,RegexExtractor
,RegexReplaceExtractor
,SplitAndIndexExtractor
,SubstringExtractor
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
static enum
static class
static class
static enum
-
Field Summary
Modifier and TypeFieldDescriptionprotected final Extractor.ConditionType
protected final String
protected final AtomicLong
protected final String
protected final Extractor.CursorStrategy
protected final AtomicLong
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
protected final String
protected long
protected Pattern
protected final String
protected final Extractor.Type
protected final String
protected final String
-
Constructor Summary
ConstructorDescriptionExtractor
(com.codahale.metrics.MetricRegistry metricRegistry, String id, String title, long order, Extractor.Type type, Extractor.CursorStrategy cursorStrategy, String sourceField, String targetField, Map<String, Object> extractorConfig, String creatorUserId, List<Converter> converters, Extractor.ConditionType conditionType, String conditionValue) -
Method Summary
Modifier and TypeMethodDescriptionlong
long
getId()
getOrder()
getTitle()
getType()
void
protected abstract Extractor.Result[]
Performs the extractor run.void
runExtractor
(Message msg) void
setOrder
(long order)
-
Field Details
-
FIELD_ID
- See Also:
-
FIELD_TITLE
- See Also:
-
FIELD_ORDER
- See Also:
-
FIELD_TYPE
- See Also:
-
FIELD_CURSOR_STRATEGY
- See Also:
-
FIELD_TARGET_FIELD
- See Also:
-
FIELD_SOURCE_FIELD
- See Also:
-
FIELD_CREATOR_USER_ID
- See Also:
-
FIELD_EXTRACTOR_CONFIG
- See Also:
-
FIELD_CONDITION_TYPE
- See Also:
-
FIELD_CONDITION_VALUE
- See Also:
-
FIELD_CONVERTERS
- See Also:
-
FIELD_CONVERTER_TYPE
- See Also:
-
FIELD_CONVERTER_CONFIG
- See Also:
-
exceptions
-
converterExceptions
-
id
-
title
-
superType
-
cursorStrategy
-
targetField
-
sourceField
-
creatorUserId
-
extractorConfig
-
converters
-
conditionType
-
conditionValue
-
order
protected long order -
regexConditionPattern
-
-
Constructor Details
-
Extractor
public Extractor(com.codahale.metrics.MetricRegistry metricRegistry, String id, String title, long order, Extractor.Type type, Extractor.CursorStrategy cursorStrategy, String sourceField, String targetField, Map<String, Object> extractorConfig, String creatorUserId, List<Converter> converters, Extractor.ConditionType conditionType, String conditionValue) throws Extractor.ReservedFieldException- Throws:
Extractor.ReservedFieldException
-
-
Method Details
-
run
Performs the extractor run.- Parameters:
field
- the field to extract- Returns:
- the extraction result
- Throws:
ExtractorException
- if the extraction hit an error
-
runExtractor
-
getId
-
getTitle
-
getOrder
-
setOrder
public void setOrder(long order) -
getType
-
getCursorStrategy
-
getTargetField
-
getSourceField
-
getExtractorConfig
-
getCreatorUserId
-
getConditionValue
-
getConditionType
-
getPersistedFields
- Specified by:
getPersistedFields
in interfaceEmbeddedPersistable
-
getConverters
-
converterConfigMap
-
getConditionHitsCounterName
-
getConditionMissesCounterName
-
getConditionTimerName
-
getExecutionTimerName
-
getConverterTimerName
-
getCompleteTimerName
-
getExceptionCount
public long getExceptionCount() -
getConverterExceptionCount
public long getConverterExceptionCount() -
incrementExceptions
public void incrementExceptions()
-