UnifiedAgentParserFilter¶

class oci.logging.models.UnifiedAgentParserFilter(**kwargs)¶

Bases: oci.logging.models.unified_agent_logging_filter.UnifiedAgentLoggingFilter

Logging parser filter object. Ref: https://docs.fluentd.org/filter/parser

Attributes

`FILTER_TYPE_CUSTOM_FILTER`	str(object=’’) -> str
`FILTER_TYPE_GREP_FILTER`	str(object=’’) -> str
`FILTER_TYPE_PARSER_FILTER`	str(object=’’) -> str
`FILTER_TYPE_RECORD_TRANSFORMER_FILTER`	str(object=’’) -> str
`emit_invalid_record_to_error`	Gets the emit_invalid_record_to_error of this UnifiedAgentParserFilter.
`filter_type`	[Required] Gets the filter_type of this UnifiedAgentLoggingFilter.
`hash_value_field`	Gets the hash_value_field of this UnifiedAgentParserFilter.
`inject_key_prefix`	Gets the inject_key_prefix of this UnifiedAgentParserFilter.
`key_name`	[Required] Gets the key_name of this UnifiedAgentParserFilter.
`name`	[Required] Gets the name of this UnifiedAgentLoggingFilter.
`parser`	[Required] Gets the parser of this UnifiedAgentParserFilter.
`remove_key_name_field`	Gets the remove_key_name_field of this UnifiedAgentParserFilter.
`replace_invalid_sequence`	Gets the replace_invalid_sequence of this UnifiedAgentParserFilter.
`reserve_data`	Gets the reserve_data of this UnifiedAgentParserFilter.
`reserve_time`	Gets the reserve_time of this UnifiedAgentParserFilter.

Methods

`__init__`(**kwargs)	Initializes a new UnifiedAgentParserFilter object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

FILTER_TYPE_CUSTOM_FILTER = 'CUSTOM_FILTER'¶

FILTER_TYPE_GREP_FILTER = 'GREP_FILTER'¶

FILTER_TYPE_PARSER_FILTER = 'PARSER_FILTER'¶

FILTER_TYPE_RECORD_TRANSFORMER_FILTER = 'RECORD_TRANSFORMER_FILTER'¶

__init__(**kwargs)¶

Initializes a new UnifiedAgentParserFilter object with values from keyword arguments. The default value of the filter_type attribute of this class is PARSER_FILTER and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

name (str) – The value to assign to the name property of this UnifiedAgentParserFilter.
filter_type (str) – The value to assign to the filter_type property of this UnifiedAgentParserFilter. Allowed values for this property are: “PARSER_FILTER”, “GREP_FILTER”, “RECORD_TRANSFORMER_FILTER”, “CUSTOM_FILTER”
parser (oci.logging.models.UnifiedAgentParser) – The value to assign to the parser property of this UnifiedAgentParserFilter.
key_name (str) – The value to assign to the key_name property of this UnifiedAgentParserFilter.
reserve_time (bool) – The value to assign to the reserve_time property of this UnifiedAgentParserFilter.
reserve_data (bool) – The value to assign to the reserve_data property of this UnifiedAgentParserFilter.
remove_key_name_field (bool) – The value to assign to the remove_key_name_field property of this UnifiedAgentParserFilter.
replace_invalid_sequence (bool) – The value to assign to the replace_invalid_sequence property of this UnifiedAgentParserFilter.
inject_key_prefix (str) – The value to assign to the inject_key_prefix property of this UnifiedAgentParserFilter.
hash_value_field (str) – The value to assign to the hash_value_field property of this UnifiedAgentParserFilter.
emit_invalid_record_to_error (bool) – The value to assign to the emit_invalid_record_to_error property of this UnifiedAgentParserFilter.

emit_invalid_record_to_error¶

Gets the emit_invalid_record_to_error of this UnifiedAgentParserFilter. If true, emit invalid record to @ERROR label. Invalid cases are: 1) key does not exist; 2) the format does not match; or 3) an unexpected error. You can rescue unexpected format logs in the @ERROR lable. If you want to ignore these errors, set this to false.

Returns:	The emit_invalid_record_to_error of this UnifiedAgentParserFilter.
Return type:	bool

filter_type¶

[Required] Gets the filter_type of this UnifiedAgentLoggingFilter. Unified schema logging filter type.

Allowed values for this property are: “PARSER_FILTER”, “GREP_FILTER”, “RECORD_TRANSFORMER_FILTER”, “CUSTOM_FILTER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The filter_type of this UnifiedAgentLoggingFilter.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

hash_value_field¶

Gets the hash_value_field of this UnifiedAgentParserFilter. Store the parsed values as a hash value in a field.

Returns:	The hash_value_field of this UnifiedAgentParserFilter.
Return type:	str

inject_key_prefix¶

Gets the inject_key_prefix of this UnifiedAgentParserFilter. Store the parsed values with the specified key name prefix.

Returns:	The inject_key_prefix of this UnifiedAgentParserFilter.
Return type:	str

key_name¶

[Required] Gets the key_name of this UnifiedAgentParserFilter. The field name in the record to parse.

Returns:	The key_name of this UnifiedAgentParserFilter.
Return type:	str

name¶

[Required] Gets the name of this UnifiedAgentLoggingFilter. Unique name for the filter.

Returns:	The name of this UnifiedAgentLoggingFilter.
Return type:	str

parser¶

[Required] Gets the parser of this UnifiedAgentParserFilter.

Returns:	The parser of this UnifiedAgentParserFilter.
Return type:	oci.logging.models.UnifiedAgentParser

remove_key_name_field¶

Gets the remove_key_name_field of this UnifiedAgentParserFilter. If true, remove the keyName field when parsing is succeeded.

Returns:	The remove_key_name_field of this UnifiedAgentParserFilter.
Return type:	bool

replace_invalid_sequence¶

Gets the replace_invalid_sequence of this UnifiedAgentParserFilter. If true, the invalid string is replaced with safe characters and is re-parsed.

Returns:	The replace_invalid_sequence of this UnifiedAgentParserFilter.
Return type:	bool

reserve_data¶

Gets the reserve_data of this UnifiedAgentParserFilter. If true, keep the original key-value pair in the parsed result.

Returns:	The reserve_data of this UnifiedAgentParserFilter.
Return type:	bool

reserve_time¶

Gets the reserve_time of this UnifiedAgentParserFilter. If true, keep the original event time in the parsed result.

Returns:	The reserve_time of this UnifiedAgentParserFilter.
Return type:	bool