README
¶
Logs Input Plugin
The logs plugin "tails" a logfile and parses each log message.
By default, the tail plugin acts like the following unix tail command:
tail -F --lines=0 myfile.log
-Fmeans that it will follow the name of the given file, so that it will be compatible with log-rotated files, and that it will retry on inaccessible files.--lines=0means that it will start at the end of the file (unless thefrom_beginningoption is set).
see http://man7.org/linux/man-pages/man1/tail.1.html for more details.
The plugin expects messages in one of the Telegraf Input Data Formats.
Configuration:
# Stream a log file, like the tail -f command
[[inputs.logs]]
## files to tail.
## These accept standard unix glob matching rules, but with the addition of
## ** as a "super asterisk". ie:
## "/var/log/**.log" -> recursively find all .log files in /var/log
## "/var/log/*/*.log" -> find all .log files with a parent dir in /var/log
## "/var/log/apache.log" -> just tail the apache log file
##
## See https://github.com/gobwas/glob for more examples
##
## Default log output destination name for all file_configs
## each file_config can override its own destination if needed
destination = "cloudwatchlogs"
## folder path where state of how much of a file has been transferred is stored
file_state_folder = "/tmp/logfile/state"
[[inputs.logs.file_config]]
file_path = "/tmp/logfile.log*"
log_group_name = "logfile.log"
log_stream_name = "<log_stream_name>"
timestamp_regex = "^(\\d{2} \\w{3} \\d{4} \\d{2}:\\d{2}:\\d{2}).*$"
timestamp_layout = ["_2 Jan 2006 15:04:05"]
timezone = "UTC"
multi_line_start_pattern = "{timestamp_regex}"
## Read file from beginning.
from_beginning = false
## Whether file is a named pipe
pipe = false
retention_in_days = -1
destination = "cloudwatchlogs"
[[inputs.logs.file_config]]
file_path = "/var/log/*.log"
## Regular expression for log files to ignore
blacklist = "journal|syslog"
## Publish all log files that match file_path
publish_multi_logs = true
log_group_name = "varlog"
log_stream_name = "<log_stream_name>"
timestamp_regex = "^(\\d{2} \\w{3} \\d{4} \\d{2}:\\d{2}:\\d{2}).*$"
timestamp_layout = ["_2 Jan 2006 15:04:05"]
timezone = "UTC"
multi_line_start_pattern = "{timestamp_regex}"
## Read file from beginning.
from_beginning = false
## Whether file is a named pipe
pipe = false
retention_in_days = -1
destination = "cloudwatchlogs"
## Max size of each log event, defaults to 262144 (256KB)
max_event_size = 262144
## Suffix to be added to truncated logline to indicate its truncation, defaults to "[Truncated...]"
truncate_suffix = "[Truncated...]"
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewTailerSrc ¶
Types ¶
type FileConfig ¶
type FileConfig struct {
//The file path for input log file.
FilePath string `toml:"file_path"`
//The blacklist used to filter out some files
Blacklist string `toml:"blacklist"`
PublishMultiLogs bool `toml:"publish_multi_logs"`
Encoding string `toml:"encoding"`
//The log group name for the input log file.
LogGroupName string `toml:"log_group_name"`
//log stream name
LogStreamName string `toml:"log_stream_name"`
//The regex of the timestampFromLogLine presents in the log entry
TimestampRegex string `toml:"timestamp_regex"`
//The timestampFromLogLine layout used in GoLang to parse the timestampFromLogLine.
TimestampLayout []string `toml:"timestamp_layout"`
//The time zone used to parse the timestampFromLogLine in the log entry.
Timezone string `toml:"timezone"`
//Indicate whether it is a start of multiline.
//If this config is not present, it means the multiline mode is disabled.
//If this config is specified as "{timestamp_regex}", it means to use the same regex as timestampFromLogLine.
//If this config is specified as some regex, it will use the regex to determine if this line is a start line of multiline entry.
MultiLineStartPattern string `toml:"multi_line_start_pattern"`
// automatically remove the file / symlink after uploading.
// This auto removal does not support the case where other log rotation mechanism is already in place.
AutoRemoval bool `toml:"auto_removal"`
//Indicate whether to tail the log file from the beginning or not.
//The default value for this field should be set as true in configuration.
//Otherwise, it may skip some log entries for timestampFromLogLine suffix roatated new file.
FromBeginning bool `toml:"from_beginning"`
//Indicate whether it is a named pipe.
Pipe bool `toml:"pipe"`
//Indicate logType for scroll
LogType string `toml:"log_type"`
//Log Destination override
Destination string `toml:"destination"`
//Max size for a single log event to be in bytes
MaxEventSize int `toml:"max_event_size"`
//Suffix to be added to truncated logline to indicate its truncation
TruncateSuffix string `toml:"truncate_suffix"`
//Indicate retention in days for log group
RetentionInDays int `toml:"retention_in_days"`
Filters []*LogFilter `toml:"filters"`
//Time *time.Location Go type timezone info.
TimezoneLoc *time.Location
//Regexp go type timestampFromLogLine regex
TimestampRegexP *regexp.Regexp
//Regexp go type multiline start regex
MultiLineStartPatternP *regexp.Regexp
//Regexp go type blacklist regex
BlacklistRegexP *regexp.Regexp
//Decoder object
Enc encoding.Encoding
// contains filtered or unexported fields
}
The file config presents the structure of configuration for a file to be tailed.
type LogFile ¶
type LogFile struct {
//array of file config for file to be monitored.
FileConfig []FileConfig `toml:"file_config"`
//store the offset of file already published.
FileStateFolder string `toml:"file_state_folder"`
//destination
Destination string `toml:"destination"`
Log telegraf.Logger `toml:"-"`
// contains filtered or unexported fields
}
func NewLogFile ¶
func NewLogFile() *LogFile
func (*LogFile) Description ¶
func (*LogFile) FindLogSrc ¶
Try to find if there is any new file needs to be added for monitoring.
func (*LogFile) SampleConfig ¶
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.