Show / Hide Table of Contents

Class UnifiedAgentParserFilter

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

Inheritance
object
UnifiedAgentLoggingFilter
UnifiedAgentParserFilter
Inherited Members
UnifiedAgentLoggingFilter.Name
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.LoggingService.Models
Assembly: OCI.DotNetSDK.Logging.dll
Syntax
public class UnifiedAgentParserFilter : UnifiedAgentLoggingFilter

Properties

EmitInvalidRecordToError

Declaration
[JsonProperty(PropertyName = "emitInvalidRecordToError")]
public bool? EmitInvalidRecordToError { get; set; }
Property Value
Type Description
bool?

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.

HashValueField

Declaration
[JsonProperty(PropertyName = "hashValueField")]
public string HashValueField { get; set; }
Property Value
Type Description
string

Store the parsed values as a hash value in a field.

InjectKeyPrefix

Declaration
[JsonProperty(PropertyName = "injectKeyPrefix")]
public string InjectKeyPrefix { get; set; }
Property Value
Type Description
string

Store the parsed values with the specified key name prefix.

KeyName

Declaration
[Required(ErrorMessage = "KeyName is required.")]
[JsonProperty(PropertyName = "keyName")]
public string KeyName { get; set; }
Property Value
Type Description
string

The field name in the record to parse.

Remarks

Required

Parser

Declaration
[Required(ErrorMessage = "Parser is required.")]
[JsonProperty(PropertyName = "parser")]
public UnifiedAgentParser Parser { get; set; }
Property Value
Type Description
UnifiedAgentParser
Remarks

Required

RemoveKeyNameField

Declaration
[JsonProperty(PropertyName = "removeKeyNameField")]
public bool? RemoveKeyNameField { get; set; }
Property Value
Type Description
bool?

If true, remove the keyName field when parsing is succeeded.

ReplaceInvalidSequence

Declaration
[JsonProperty(PropertyName = "replaceInvalidSequence")]
public bool? ReplaceInvalidSequence { get; set; }
Property Value
Type Description
bool?

If true, the invalid string is replaced with safe characters and is re-parsed.

ReserveData

Declaration
[JsonProperty(PropertyName = "reserveData")]
public bool? ReserveData { get; set; }
Property Value
Type Description
bool?

If true, keep the original key-value pair in the parsed result.

ReserveTime

Declaration
[JsonProperty(PropertyName = "reserveTime")]
public bool? ReserveTime { get; set; }
Property Value
Type Description
bool?

If true, keep the original event time in the parsed result.

In this article
Back to top