Class GrokProcessor

Inheritance
object
ProcessorBase
GrokProcessor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GrokProcessor : ProcessorBase, IGrokProcessor, IProcessor

Properties

| Edit this page View Source

Field

The field to use for grok expression parsing

Declaration
public Field Field { get; set; }
Property Value
Type Description
Field
| Edit this page View Source

IgnoreMissing

If true and Field does not exist or is null, the processor quietly exits without modifying the document. Default is false

Declaration
public bool? IgnoreMissing { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Name

Declaration
protected override string Name { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

PatternDefinitions

A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor. Patterns matching existing names will override the pre-existing definition.

Declaration
public IDictionary<string, string> PatternDefinitions { get; set; }
Property Value
Type Description
IDictionary<string, string>
| Edit this page View Source

Patterns

An ordered list of grok expression to match and extract named captures with. Returns on the first expression in the list that matches.

Declaration
public IEnumerable<string> Patterns { get; set; }
Property Value
Type Description
IEnumerable<string>
| Edit this page View Source

TraceMatch

when true, _ingest._grok_match_index will be inserted into your matched document’s metadata with the index into the pattern found in patterns that matched.

Declaration
public bool? TraceMatch { get; set; }
Property Value
Type Description
bool?

Implements

Extension Methods