Class KeyValueProcessor

Processor to automatically parse messages (or specific event fields) which are of the key=value variety.

Inheritance

object

ProcessorBase

KeyValueProcessor

Implements

IKeyValueProcessor

IProcessor

Inherited Members

ProcessorBase.If

ProcessorBase.Tag

ProcessorBase.IgnoreFailure

ProcessorBase.OnFailure

ProcessorBase.Description

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class KeyValueProcessor : ProcessorBase, IKeyValueProcessor, IProcessor

Properties

ExcludeKeys

List of keys to exclude from document

Declaration

public IEnumerable<string> ExcludeKeys { get; set; }

Property Value

Type	Description
IEnumerable<string>

Field

The field to be parsed

Declaration

public Field Field { get; set; }

Property Value

Type	Description
Field

FieldSplit

Regex pattern to use for splitting key-value pairs

Declaration

public string FieldSplit { get; set; }

Property Value

Type	Description
string

IgnoreMissing

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

Declaration

public bool? IgnoreMissing { get; set; }

Property Value

Type	Description
bool?

IncludeKeys

List of keys to filter and insert into document. Defaults to including all keys

Declaration

public IEnumerable<string> IncludeKeys { get; set; }

Property Value

Type	Description
IEnumerable<string>

Name

Declaration

protected override string Name { get; }

Property Value

Type	Description
string

Overrides

ProcessorBase.Name

Prefix

Prefix to be added to extracted keys

Declaration

public string Prefix { get; set; }

Property Value

Type	Description
string

StripBrackets

If true strip brackets (), <>, [] as well as quotes ' and " from extracted values

Declaration

public bool? StripBrackets { get; set; }

Property Value

Type	Description
bool?

TargetField

The field to insert the extracted keys into. Defaults to the root of the document

Declaration

public Field TargetField { get; set; }

Property Value

Type	Description
Field

TrimKey

String of characters to trim from extracted keys

Declaration

public string TrimKey { get; set; }

Property Value

Type	Description
string

TrimValue

String of characters to trim from extracted values

Declaration

public string TrimValue { get; set; }

Property Value

Type	Description
string

ValueSplit

Regex pattern to use for splitting the key from the value within a key-value pair

Declaration

public string ValueSplit { get; set; }

Property Value

Type	Description
string

Implements

IKeyValueProcessor

IProcessor

Extension Methods

SuffixExtensions.Suffix(object, string)