UnifiedAgentSyslogParser

class oci.logging.models.UnifiedAgentSyslogParser(**kwargs)

Bases: oci.logging.models.unified_agent_parser.UnifiedAgentParser

Syslog Parser.

Attributes

MESSAGE_FORMAT_AUTO A constant which can be used with the message_format property of a UnifiedAgentSyslogParser.
MESSAGE_FORMAT_RFC3164 A constant which can be used with the message_format property of a UnifiedAgentSyslogParser.
MESSAGE_FORMAT_RFC5424 A constant which can be used with the message_format property of a UnifiedAgentSyslogParser.
PARSER_TYPE_APACHE2 str(object=’’) -> str
PARSER_TYPE_APACHE_ERROR str(object=’’) -> str
PARSER_TYPE_AUDITD str(object=’’) -> str
PARSER_TYPE_CSV str(object=’’) -> str
PARSER_TYPE_GROK str(object=’’) -> str
PARSER_TYPE_JSON str(object=’’) -> str
PARSER_TYPE_MSGPACK str(object=’’) -> str
PARSER_TYPE_MULTILINE str(object=’’) -> str
PARSER_TYPE_MULTILINE_GROK str(object=’’) -> str
PARSER_TYPE_NONE str(object=’’) -> str
PARSER_TYPE_REGEXP str(object=’’) -> str
PARSER_TYPE_SYSLOG str(object=’’) -> str
PARSER_TYPE_TSV str(object=’’) -> str
SYSLOG_PARSER_TYPE_REGEXP A constant which can be used with the syslog_parser_type property of a UnifiedAgentSyslogParser.
SYSLOG_PARSER_TYPE_STRING A constant which can be used with the syslog_parser_type property of a UnifiedAgentSyslogParser.
field_time_key Gets the field_time_key of this UnifiedAgentParser.
is_estimate_current_event Gets the is_estimate_current_event of this UnifiedAgentParser.
is_keep_time_key Gets the is_keep_time_key of this UnifiedAgentParser.
is_null_empty_string Gets the is_null_empty_string of this UnifiedAgentParser.
is_support_colonless_ident Gets the is_support_colonless_ident of this UnifiedAgentSyslogParser.
is_with_priority Gets the is_with_priority of this UnifiedAgentSyslogParser.
message_format Gets the message_format of this UnifiedAgentSyslogParser.
null_value_pattern Gets the null_value_pattern of this UnifiedAgentParser.
parser_type [Required] Gets the parser_type of this UnifiedAgentParser.
rfc5424_time_format Gets the rfc5424_time_format of this UnifiedAgentSyslogParser.
syslog_parser_type Gets the syslog_parser_type of this UnifiedAgentSyslogParser.
time_format Gets the time_format of this UnifiedAgentSyslogParser.
timeout_in_milliseconds Gets the timeout_in_milliseconds of this UnifiedAgentParser.
types Gets the types of this UnifiedAgentParser.

Methods

__init__(**kwargs) Initializes a new UnifiedAgentSyslogParser 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.
MESSAGE_FORMAT_AUTO = 'AUTO'

A constant which can be used with the message_format property of a UnifiedAgentSyslogParser. This constant has a value of “AUTO”

MESSAGE_FORMAT_RFC3164 = 'RFC3164'

A constant which can be used with the message_format property of a UnifiedAgentSyslogParser. This constant has a value of “RFC3164”

MESSAGE_FORMAT_RFC5424 = 'RFC5424'

A constant which can be used with the message_format property of a UnifiedAgentSyslogParser. This constant has a value of “RFC5424”

PARSER_TYPE_APACHE2 = 'APACHE2'
PARSER_TYPE_APACHE_ERROR = 'APACHE_ERROR'
PARSER_TYPE_AUDITD = 'AUDITD'
PARSER_TYPE_CSV = 'CSV'
PARSER_TYPE_GROK = 'GROK'
PARSER_TYPE_JSON = 'JSON'
PARSER_TYPE_MSGPACK = 'MSGPACK'
PARSER_TYPE_MULTILINE = 'MULTILINE'
PARSER_TYPE_MULTILINE_GROK = 'MULTILINE_GROK'
PARSER_TYPE_NONE = 'NONE'
PARSER_TYPE_REGEXP = 'REGEXP'
PARSER_TYPE_SYSLOG = 'SYSLOG'
PARSER_TYPE_TSV = 'TSV'
SYSLOG_PARSER_TYPE_REGEXP = 'REGEXP'

A constant which can be used with the syslog_parser_type property of a UnifiedAgentSyslogParser. This constant has a value of “REGEXP”

SYSLOG_PARSER_TYPE_STRING = 'STRING'

A constant which can be used with the syslog_parser_type property of a UnifiedAgentSyslogParser. This constant has a value of “STRING”

__init__(**kwargs)

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

Parameters:
  • parser_type (str) – The value to assign to the parser_type property of this UnifiedAgentSyslogParser. Allowed values for this property are: “AUDITD”, “JSON”, “TSV”, “CSV”, “NONE”, “SYSLOG”, “APACHE2”, “APACHE_ERROR”, “MSGPACK”, “REGEXP”, “MULTILINE”, “GROK”, “MULTILINE_GROK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • field_time_key (str) – The value to assign to the field_time_key property of this UnifiedAgentSyslogParser.
  • types (dict(str, str)) – The value to assign to the types property of this UnifiedAgentSyslogParser.
  • null_value_pattern (str) – The value to assign to the null_value_pattern property of this UnifiedAgentSyslogParser.
  • is_null_empty_string (bool) – The value to assign to the is_null_empty_string property of this UnifiedAgentSyslogParser.
  • is_estimate_current_event (bool) – The value to assign to the is_estimate_current_event property of this UnifiedAgentSyslogParser.
  • is_keep_time_key (bool) – The value to assign to the is_keep_time_key property of this UnifiedAgentSyslogParser.
  • timeout_in_milliseconds (int) – The value to assign to the timeout_in_milliseconds property of this UnifiedAgentSyslogParser.
  • time_format (str) – The value to assign to the time_format property of this UnifiedAgentSyslogParser.
  • rfc5424_time_format (str) – The value to assign to the rfc5424_time_format property of this UnifiedAgentSyslogParser.
  • message_format (str) – The value to assign to the message_format property of this UnifiedAgentSyslogParser. Allowed values for this property are: “RFC3164”, “RFC5424”, “AUTO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • is_with_priority (bool) – The value to assign to the is_with_priority property of this UnifiedAgentSyslogParser.
  • is_support_colonless_ident (bool) – The value to assign to the is_support_colonless_ident property of this UnifiedAgentSyslogParser.
  • syslog_parser_type (str) – The value to assign to the syslog_parser_type property of this UnifiedAgentSyslogParser. Allowed values for this property are: “STRING”, “REGEXP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
field_time_key

Gets the field_time_key of this UnifiedAgentParser. Specify time field for the event time. If the event doesn’t have this field, the current time is used.

Returns:The field_time_key of this UnifiedAgentParser.
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.

is_estimate_current_event

Gets the is_estimate_current_event of this UnifiedAgentParser. If true, use Fluent::EventTime.now(current time) as a timestamp when time_key is specified.

Returns:The is_estimate_current_event of this UnifiedAgentParser.
Return type:bool
is_keep_time_key

Gets the is_keep_time_key of this UnifiedAgentParser. If true, keep time field in the record.

Returns:The is_keep_time_key of this UnifiedAgentParser.
Return type:bool
is_null_empty_string

Gets the is_null_empty_string of this UnifiedAgentParser. If true, an empty string field is replaced with nil.

Returns:The is_null_empty_string of this UnifiedAgentParser.
Return type:bool
is_support_colonless_ident

Gets the is_support_colonless_ident of this UnifiedAgentSyslogParser.

Returns:The is_support_colonless_ident of this UnifiedAgentSyslogParser.
Return type:bool
is_with_priority

Gets the is_with_priority of this UnifiedAgentSyslogParser.

Returns:The is_with_priority of this UnifiedAgentSyslogParser.
Return type:bool
message_format

Gets the message_format of this UnifiedAgentSyslogParser. Allowed values for this property are: “RFC3164”, “RFC5424”, “AUTO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The message_format of this UnifiedAgentSyslogParser.
Return type:str
null_value_pattern

Gets the null_value_pattern of this UnifiedAgentParser. Specify the null value pattern.

Returns:The null_value_pattern of this UnifiedAgentParser.
Return type:str
parser_type

[Required] Gets the parser_type of this UnifiedAgentParser. Type of fluent parser.

Allowed values for this property are: “AUDITD”, “JSON”, “TSV”, “CSV”, “NONE”, “SYSLOG”, “APACHE2”, “APACHE_ERROR”, “MSGPACK”, “REGEXP”, “MULTILINE”, “GROK”, “MULTILINE_GROK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The parser_type of this UnifiedAgentParser.
Return type:str
rfc5424_time_format

Gets the rfc5424_time_format of this UnifiedAgentSyslogParser.

Returns:The rfc5424_time_format of this UnifiedAgentSyslogParser.
Return type:str
syslog_parser_type

Gets the syslog_parser_type of this UnifiedAgentSyslogParser. Allowed values for this property are: “STRING”, “REGEXP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The syslog_parser_type of this UnifiedAgentSyslogParser.
Return type:str
time_format

Gets the time_format of this UnifiedAgentSyslogParser.

Returns:The time_format of this UnifiedAgentSyslogParser.
Return type:str
timeout_in_milliseconds

Gets the timeout_in_milliseconds of this UnifiedAgentParser. Specify the timeout for parse processing. This is mainly for detecting an incorrect regexp pattern.

Returns:The timeout_in_milliseconds of this UnifiedAgentParser.
Return type:int
types

Gets the types of this UnifiedAgentParser. Specify types for converting a field into another type.

Returns:The types of this UnifiedAgentParser.
Return type:dict(str, str)