public class ExtractRuleInfo extends AbstractModel
header, skipSign
Constructor and Description |
---|
ExtractRuleInfo() |
ExtractRuleInfo(ExtractRuleInfo source)
NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
|
Modifier and Type | Method and Description |
---|---|
String |
getAddress()
Get syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port],只有在LogType为service_syslog时生效,其余类型无需填写。
注意:
- 该字段适用于:创建采集规则配置、修改采集规则配置。
- COS导入不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。
|
AdvanceFilterRuleInfo[] |
getAdvanceFilterRules()
Get 日志过滤规则列表(新版)。
注意:
- 2.9.3以下版本LogListener不支持, 请使用FilterKeyRegex配置日志过滤规则。
- 自建k8s采集配置(CreateConfigExtra、ModifyConfigExtra)不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。
|
Long |
getBacktracking()
Get 增量采集模式下的回溯数据量,默认:-1(全量采集);其他非负数表示增量采集(从最新的位置,往前采集${Backtracking}字节(Byte)的日志)最大支持1073741824(1G)。
注意:
- COS导入不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。
|
String |
getBeginRegex()
Get 行首匹配规则,只有LogType为multiline_log或fullregex_log时有效
注意:此字段可能返回 null,表示取不到有效值。
|
String |
getDelimiter()
Get 分隔符类型日志的分隔符,只有LogType为delimiter_log时有效
注意:此字段可能返回 null,表示取不到有效值。
|
EventLog[] |
getEventLogRules()
Get Windows事件日志采集规则,只有在LogType为windows_event_log时生效,其余类型无需填写。
|
KeyRegexInfo[] |
getFilterKeyRegex()
Get 日志过滤规则列表(旧版),需要过滤日志的key,及其对应的regex。
注意:2.9.3及以上版本LogListener ,建议使用AdvanceFilterRules配置日志过滤规则。
注意:此字段可能返回 null,表示取不到有效值。
|
Long |
getIsGBK()
Get 是否为Gbk编码。 0:否;1:是。
注意
- 目前取0值时,表示UTF-8编码
- COS导入不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。
|
Long |
getJsonStandard()
Get 是否为标准json。 0:否; 1:是。
- 标准json指采集器使用业界标准开源解析器进行json解析,非标json指采集器使用CLS自研json解析器进行解析,两种解析器没有本质区别,建议客户使用标准json进行解析。
注意:此字段可能返回 null,表示取不到有效值。
|
String[] |
getKeys()
Get 取的每个字段的key名字,为空的key代表丢弃这个字段,只有LogType为delimiter_log时有效,json_log的日志使用json本身的key。限制100个。
注意:此字段可能返回 null,表示取不到有效值。
|
String |
getLogRegex()
Get 整条日志匹配规则,只有LogType为fullregex_log时有效
注意:此字段可能返回 null,表示取不到有效值。
|
Long |
getMetadataType()
Get 元数据类型。0: 不使用元数据信息;1:使用机器组元数据;2:使用用户自定义元数据;3:使用采集配置路径。
注意:
- COS导入不支持此字段。
|
MetaTagInfo[] |
getMetaTags()
Get 用户自定义元数据信息。
注意:
- MetadataType为2时必填。
- COS导入不支持此字段。
|
String |
getParseProtocol()
Get rfc3164:指定系统日志采集使用RFC3164协议解析日志。
rfc5424:指定系统日志采集使用RFC5424协议解析日志。
auto:自动匹配rfc3164或者rfc5424其中一种协议。
只有在LogType为service_syslog时生效,其余类型无需填写。
注意:
- 该字段适用于:创建采集规则配置、修改采集规则配置
- COS导入不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。
|
String |
getPathRegex()
Get 采集配置路径正则表达式。
注意:
- MetadataType为3时必填。
- COS导入不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。
|
String |
getProtocol()
Get syslog传输协议,取值为tcp或者udp,只有在LogType为service_syslog时生效,其余类型无需填写。
注意:
- 该字段适用于:创建采集规则配置、修改采集规则配置。
- COS导入不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。
|
String |
getTimeFormat()
Get 时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数
注意:此字段可能返回 null,表示取不到有效值。
|
String |
getTimeKey()
Get 时间字段的key名字,TikeKey和TimeFormat必须成对出现
注意:此字段可能返回 null,表示取不到有效值。
|
String |
getUnMatchLogKey()
Get 失败日志的key,当UnMatchUpLoadSwitch为true时必填
注意:此字段可能返回 null,表示取不到有效值。
|
Boolean |
getUnMatchUpLoadSwitch()
Get 解析失败日志是否上传,true表示上传,false表示不上传
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setAddress(String Address)
Set syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port],只有在LogType为service_syslog时生效,其余类型无需填写。
注意:
- 该字段适用于:创建采集规则配置、修改采集规则配置。
- COS导入不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setAdvanceFilterRules(AdvanceFilterRuleInfo[] AdvanceFilterRules)
Set 日志过滤规则列表(新版)。
注意:
- 2.9.3以下版本LogListener不支持, 请使用FilterKeyRegex配置日志过滤规则。
- 自建k8s采集配置(CreateConfigExtra、ModifyConfigExtra)不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setBacktracking(Long Backtracking)
Set 增量采集模式下的回溯数据量,默认:-1(全量采集);其他非负数表示增量采集(从最新的位置,往前采集${Backtracking}字节(Byte)的日志)最大支持1073741824(1G)。
注意:
- COS导入不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setBeginRegex(String BeginRegex)
Set 行首匹配规则,只有LogType为multiline_log或fullregex_log时有效
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setDelimiter(String Delimiter)
Set 分隔符类型日志的分隔符,只有LogType为delimiter_log时有效
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setEventLogRules(EventLog[] EventLogRules)
Set Windows事件日志采集规则,只有在LogType为windows_event_log时生效,其余类型无需填写。
|
void |
setFilterKeyRegex(KeyRegexInfo[] FilterKeyRegex)
Set 日志过滤规则列表(旧版),需要过滤日志的key,及其对应的regex。
注意:2.9.3及以上版本LogListener ,建议使用AdvanceFilterRules配置日志过滤规则。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setIsGBK(Long IsGBK)
Set 是否为Gbk编码。 0:否;1:是。
注意
- 目前取0值时,表示UTF-8编码
- COS导入不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setJsonStandard(Long JsonStandard)
Set 是否为标准json。 0:否; 1:是。
- 标准json指采集器使用业界标准开源解析器进行json解析,非标json指采集器使用CLS自研json解析器进行解析,两种解析器没有本质区别,建议客户使用标准json进行解析。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setKeys(String[] Keys)
Set 取的每个字段的key名字,为空的key代表丢弃这个字段,只有LogType为delimiter_log时有效,json_log的日志使用json本身的key。限制100个。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setLogRegex(String LogRegex)
Set 整条日志匹配规则,只有LogType为fullregex_log时有效
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setMetadataType(Long MetadataType)
Set 元数据类型。0: 不使用元数据信息;1:使用机器组元数据;2:使用用户自定义元数据;3:使用采集配置路径。
注意:
- COS导入不支持此字段。
|
void |
setMetaTags(MetaTagInfo[] MetaTags)
Set 用户自定义元数据信息。
注意:
- MetadataType为2时必填。
- COS导入不支持此字段。
|
void |
setParseProtocol(String ParseProtocol)
Set rfc3164:指定系统日志采集使用RFC3164协议解析日志。
rfc5424:指定系统日志采集使用RFC5424协议解析日志。
auto:自动匹配rfc3164或者rfc5424其中一种协议。
只有在LogType为service_syslog时生效,其余类型无需填写。
注意:
- 该字段适用于:创建采集规则配置、修改采集规则配置
- COS导入不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setPathRegex(String PathRegex)
Set 采集配置路径正则表达式。
注意:
- MetadataType为3时必填。
- COS导入不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setProtocol(String Protocol)
Set syslog传输协议,取值为tcp或者udp,只有在LogType为service_syslog时生效,其余类型无需填写。
注意:
- 该字段适用于:创建采集规则配置、修改采集规则配置。
- COS导入不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setTimeFormat(String TimeFormat)
Set 时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setTimeKey(String TimeKey)
Set 时间字段的key名字,TikeKey和TimeFormat必须成对出现
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setUnMatchLogKey(String UnMatchLogKey)
Set 失败日志的key,当UnMatchUpLoadSwitch为true时必填
注意:此字段可能返回 null,表示取不到有效值。
|
void |
setUnMatchUpLoadSwitch(Boolean UnMatchUpLoadSwitch)
Set 解析失败日志是否上传,true表示上传,false表示不上传
注意:此字段可能返回 null,表示取不到有效值。
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
public ExtractRuleInfo()
public ExtractRuleInfo(ExtractRuleInfo source)
public String getTimeKey()
public void setTimeKey(String TimeKey)
TimeKey
- 时间字段的key名字,TikeKey和TimeFormat必须成对出现
注意:此字段可能返回 null,表示取不到有效值。public String getTimeFormat()
public void setTimeFormat(String TimeFormat)
TimeFormat
- 时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数
注意:此字段可能返回 null,表示取不到有效值。public String getDelimiter()
public void setDelimiter(String Delimiter)
Delimiter
- 分隔符类型日志的分隔符,只有LogType为delimiter_log时有效
注意:此字段可能返回 null,表示取不到有效值。public String getLogRegex()
public void setLogRegex(String LogRegex)
LogRegex
- 整条日志匹配规则,只有LogType为fullregex_log时有效
注意:此字段可能返回 null,表示取不到有效值。public String getBeginRegex()
public void setBeginRegex(String BeginRegex)
BeginRegex
- 行首匹配规则,只有LogType为multiline_log或fullregex_log时有效
注意:此字段可能返回 null,表示取不到有效值。public String[] getKeys()
public void setKeys(String[] Keys)
Keys
- 取的每个字段的key名字,为空的key代表丢弃这个字段,只有LogType为delimiter_log时有效,json_log的日志使用json本身的key。限制100个。
注意:此字段可能返回 null,表示取不到有效值。public KeyRegexInfo[] getFilterKeyRegex()
public void setFilterKeyRegex(KeyRegexInfo[] FilterKeyRegex)
FilterKeyRegex
- 日志过滤规则列表(旧版),需要过滤日志的key,及其对应的regex。
注意:2.9.3及以上版本LogListener ,建议使用AdvanceFilterRules配置日志过滤规则。
注意:此字段可能返回 null,表示取不到有效值。public Boolean getUnMatchUpLoadSwitch()
public void setUnMatchUpLoadSwitch(Boolean UnMatchUpLoadSwitch)
UnMatchUpLoadSwitch
- 解析失败日志是否上传,true表示上传,false表示不上传
注意:此字段可能返回 null,表示取不到有效值。public String getUnMatchLogKey()
public void setUnMatchLogKey(String UnMatchLogKey)
UnMatchLogKey
- 失败日志的key,当UnMatchUpLoadSwitch为true时必填
注意:此字段可能返回 null,表示取不到有效值。public Long getBacktracking()
public void setBacktracking(Long Backtracking)
Backtracking
- 增量采集模式下的回溯数据量,默认:-1(全量采集);其他非负数表示增量采集(从最新的位置,往前采集${Backtracking}字节(Byte)的日志)最大支持1073741824(1G)。
注意:
- COS导入不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。public Long getIsGBK()
public void setIsGBK(Long IsGBK)
IsGBK
- 是否为Gbk编码。 0:否;1:是。
注意
- 目前取0值时,表示UTF-8编码
- COS导入不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。public Long getJsonStandard()
public void setJsonStandard(Long JsonStandard)
JsonStandard
- 是否为标准json。 0:否; 1:是。
- 标准json指采集器使用业界标准开源解析器进行json解析,非标json指采集器使用CLS自研json解析器进行解析,两种解析器没有本质区别,建议客户使用标准json进行解析。
注意:此字段可能返回 null,表示取不到有效值。public String getProtocol()
public void setProtocol(String Protocol)
Protocol
- syslog传输协议,取值为tcp或者udp,只有在LogType为service_syslog时生效,其余类型无需填写。
注意:
- 该字段适用于:创建采集规则配置、修改采集规则配置。
- COS导入不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。public String getAddress()
public void setAddress(String Address)
Address
- syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port],只有在LogType为service_syslog时生效,其余类型无需填写。
注意:
- 该字段适用于:创建采集规则配置、修改采集规则配置。
- COS导入不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。public String getParseProtocol()
public void setParseProtocol(String ParseProtocol)
ParseProtocol
- rfc3164:指定系统日志采集使用RFC3164协议解析日志。
rfc5424:指定系统日志采集使用RFC5424协议解析日志。
auto:自动匹配rfc3164或者rfc5424其中一种协议。
只有在LogType为service_syslog时生效,其余类型无需填写。
注意:
- 该字段适用于:创建采集规则配置、修改采集规则配置
- COS导入不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。public Long getMetadataType()
public void setMetadataType(Long MetadataType)
MetadataType
- 元数据类型。0: 不使用元数据信息;1:使用机器组元数据;2:使用用户自定义元数据;3:使用采集配置路径。
注意:
- COS导入不支持此字段。public String getPathRegex()
public void setPathRegex(String PathRegex)
PathRegex
- 采集配置路径正则表达式。
注意:
- MetadataType为3时必填。
- COS导入不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。public MetaTagInfo[] getMetaTags()
public void setMetaTags(MetaTagInfo[] MetaTags)
MetaTags
- 用户自定义元数据信息。
注意:
- MetadataType为2时必填。
- COS导入不支持此字段。public EventLog[] getEventLogRules()
public void setEventLogRules(EventLog[] EventLogRules)
EventLogRules
- Windows事件日志采集规则,只有在LogType为windows_event_log时生效,其余类型无需填写。public AdvanceFilterRuleInfo[] getAdvanceFilterRules()
public void setAdvanceFilterRules(AdvanceFilterRuleInfo[] AdvanceFilterRules)
AdvanceFilterRules
- 日志过滤规则列表(新版)。
注意:
- 2.9.3以下版本LogListener不支持, 请使用FilterKeyRegex配置日志过滤规则。
- 自建k8s采集配置(CreateConfigExtra、ModifyConfigExtra)不支持此字段。
注意:此字段可能返回 null,表示取不到有效值。Copyright © 2024. All rights reserved.