com.aliyun.openservices.log.common

Class ConfigInputDetail

java.lang.Object

com.aliyun.openservices.log.common.CommonConfigInputDetail

com.aliyun.openservices.log.common.LocalFileConfigInputDetail

com.aliyun.openservices.log.common.ConfigInputDetail

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

LocalFilePluginConfigInputDetail

public class ConfigInputDetail
extends LocalFileConfigInputDetail
implements Serializable

The input config of a logtail config

See Also:

Serialized Form

Field Summary

Fields inherited from class com.aliyun.openservices.log.common.LocalFileConfigInputDetail

advanced, delaySkipBytes, discardNonUtf8, discardUnmatch, dockerExcludeEnv, dockerExcludeLabel, dockerIncludeEnv, dockerIncludeLabel, fileEncoding, filePattern, isDockerFile, logPath, logType, maxDepth, pluginDetail, preserve, preserveDepth, tailExisted, timeFormat, topicFormat

Fields inherited from class com.aliyun.openservices.log.common.CommonConfigInputDetail

adjustTimezone, delayAlarmBytes, enableRawLog, enableTag, filterKey, filterRegex, localStorage, logTimezone, maxSendRate, mergeType, priority, sendRateExpire, sensitiveKeys, shardHashKey

Constructor Summary

Constructors

Constructor and Description
ConfigInputDetail()
ConfigInputDetail(ConfigInputDetail inputDetail)
ConfigInputDetail(String logPath, String filePattern, String logType, String logBeginRegex, String regex, ArrayList<String> key, String timeFormat, boolean localStorage)
ConfigInputDetail(String logPath, String filePattern, String logType, String logBeginRegex, String regex, ArrayList<String> key, String timeFormat, boolean localStorage, String customizedFields)

Method Summary

Modifier and Type	Method and Description
void	FromJsonObject(com.alibaba.fastjson.JSONObject inputDetail)
void	FromJsonString(String inputDetailString)
String	GetCustomizedFields()
ArrayList<String>	GetKey()
String	GetLogBeginRegex()
String	GetRegex()
void	SetCustomizedFields(String customizedFields)
void	SetKey(ArrayList<String> key)
void	SetKey(com.alibaba.fastjson.JSONArray key)
void	SetLogBeginRegex(String logBeginRegex)
void	SetRegex(String regex)
com.alibaba.fastjson.JSONObject	ToJsonObject()
String	ToJsonString()

Methods inherited from class com.aliyun.openservices.log.common.LocalFileConfigInputDetail

getAdvanced, getDelaySkipBytes, GetDiscardNonUtf8, GetDiscardUnmatch, getDockerExcludeEnv, getDockerExcludeLabel, getDockerIncludeEnv, getDockerIncludeLabel, GetFileEncoding, GetFilePattern, GetLogPath, GetLogType, GetMaxDepth, GetPluginDetail, GetPreserve, GetPreserveDepth, GetTailExisted, GetTimeFormat, GetTopicFormat, isDockerFile, LocalFileConfigFromJsonObject, LocalFileConfigToJsonObject, setAdvanced, setDelaySkipBytes, SetDiscardNonUtf8, SetDiscardUnmatch, setDockerExcludeEnv, setDockerExcludeLabel, setDockerFile, setDockerIncludeEnv, setDockerIncludeLabel, SetFileEncoding, SetFilePattern, SetLogPath, SetLogType, SetMaxDepth, SetPluginDetail, SetPreserve, SetPreserveDepth, SetTailExisted, SetTimeFormat, SetTopicFormat

Methods inherited from class com.aliyun.openservices.log.common.CommonConfigInputDetail

CommonConfigFromJsonObject, CommonConfigToJsonObject, FromJsonObjectS, FromJsonStringS, getDelayAlarmBytes, GetEnableRawLog, GetEnableTag, GetFilterKey, GetFilterRegex, GetLocalStorage, getLogTimezone, getMaxSendRate, getMergeType, getPriority, getSendRateExpire, GetSensitiveKeys, GetShardHashKey, isAdjustTimezone, setAdjustTimezone, setDelayAlarmBytes, SetEnableRawLog, SetEnableTag, SetFilterKey, SetFilterKeyRegex, SetFilterRegex, SetLocalStorage, setLogTimezone, setMaxSendRate, setMergeType, setPriority, setSendRateExpire, SetSensitiveKeys, SetShardHashKey, SetShardHashKeyList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigInputDetail

public ConfigInputDetail()

ConfigInputDetail

public ConfigInputDetail(String logPath,
                         String filePattern,
                         String logType,
                         String logBeginRegex,
                         String regex,
                         ArrayList<String> key,
                         String timeFormat,
                         boolean localStorage)

Parameters:

logPath - the log file dir path

filePattern - the file name pattern, e.g "access.log" , "access.log.*"

logType - the log data type , currently it only support "common_reg_log", "apsara_log", "streamlog"

logBeginRegex - the regex used to check if one line match the start of a log

regex - the regex used to parse the log data if log type is "common_reg_log", leave to "" if log type is "apsara_log"

key - the key lists for every captured value using the defined regex, "time" must be one name in key

timeFormat - the time format to parse the "time" field

localStorage - true if save the log data if failed to send to the sls server

ConfigInputDetail

public ConfigInputDetail(String logPath,
                         String filePattern,
                         String logType,
                         String logBeginRegex,
                         String regex,
                         ArrayList<String> key,
                         String timeFormat,
                         boolean localStorage,
                         String customizedFields)

Parameters:

logPath - the log file dir path

filePattern - the file name pattern, e.g "access.log" , "access.log.*"

logType - the log data type , currently it only support "common_reg_log", "apsara_log", "streamlog"

logBeginRegex - the regex used to check if one line match the start of a log

regex - the regex used to parse the log data if log type is "common_reg_log", leave to "" if log type is "apsara_log"

key - the key lists for every captured value using the defined regex, "time" must be one name in key

timeFormat - the time format to parse the "time" field

localStorage - true if save the log data if failed to send to the sls server

customizedFields - the customized fields configuration for special usage

ConfigInputDetail

public ConfigInputDetail(ConfigInputDetail inputDetail)

Method Detail

ToJsonObject

public com.alibaba.fastjson.JSONObject ToJsonObject()

Specified by:

ToJsonObject in class CommonConfigInputDetail

ToJsonString

public String ToJsonString()

FromJsonObject

public void FromJsonObject(com.alibaba.fastjson.JSONObject inputDetail)
                    throws LogException

Specified by:

FromJsonObject in class CommonConfigInputDetail

Throws:

LogException

FromJsonString

public void FromJsonString(String inputDetailString)
                    throws LogException

Throws:

LogException

GetKey

public ArrayList<String> GetKey()

SetKey

public void SetKey(ArrayList<String> key)

SetKey

public void SetKey(com.alibaba.fastjson.JSONArray key)
            throws LogException

Throws:

LogException

GetLogBeginRegex

public String GetLogBeginRegex()

SetLogBeginRegex

public void SetLogBeginRegex(String logBeginRegex)

GetRegex

public String GetRegex()

SetRegex

public void SetRegex(String regex)

GetCustomizedFields

public String GetCustomizedFields()

SetCustomizedFields

public void SetCustomizedFields(String customizedFields)