class Amazonite::CloudWatchLogs::ParseKeyValue

Overview

This processor parses a specified field in the original log event into key-value pairs.

For more information about this processor including examples, see parseKeyValue in the CloudWatch Logs User Guide.

Included Modules

Defined in:

cloudwatch_logs/parse_key_value.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(source : String | Nil = nil, destination : String | Nil = nil, field_delimiter : String | Nil = nil, key_value_delimiter : String | Nil = nil, key_prefix : String | Nil = nil, non_match_value : String | Nil = nil, overwrite_if_exists : Bool | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def destination : String | Nil #

The destination field to put the extracted key-value pairs into


[View source]
def destination=(destination : String | Nil) #

The destination field to put the extracted key-value pairs into


[View source]
def field_delimiter : String | Nil #

The field delimiter string that is used between key-value pairs in the original log events. If you omit this, the ampersand & character is used.


[View source]
def field_delimiter=(field_delimiter : String | Nil) #

The field delimiter string that is used between key-value pairs in the original log events. If you omit this, the ampersand & character is used.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def key_prefix : String | Nil #

If you want to add a prefix to all transformed keys, specify it here.


[View source]
def key_prefix=(key_prefix : String | Nil) #

If you want to add a prefix to all transformed keys, specify it here.


[View source]
def key_value_delimiter : String | Nil #

The delimiter string to use between the key and value in each pair in the transformed log event.

If you omit this, the equal = character is used.


[View source]
def key_value_delimiter=(key_value_delimiter : String | Nil) #

The delimiter string to use between the key and value in each pair in the transformed log event.

If you omit this, the equal = character is used.


[View source]
def non_match_value : String | Nil #

A value to insert into the value field in the result, when a key-value pair is not successfully split.


[View source]
def non_match_value=(non_match_value : String | Nil) #

A value to insert into the value field in the result, when a key-value pair is not successfully split.


[View source]
def overwrite_if_exists : Bool | Nil #

Specifies whether to overwrite the value if the destination key already exists. If you omit this, the default is false.


[View source]
def overwrite_if_exists=(overwrite_if_exists : Bool | Nil) #

Specifies whether to overwrite the value if the destination key already exists. If you omit this, the default is false.


[View source]
def source : String | Nil #

Path to the field in the log event that will be parsed. Use dot notation to access child fields. For example, store.book


[View source]
def source=(source : String | Nil) #

Path to the field in the log event that will be parsed. Use dot notation to access child fields. For example, store.book


[View source]
def validate! : Nil #

[View source]