Update logfile documentation

This commit is contained in:
Daniel Nelson
2019-05-03 10:55:11 -07:00
parent bcf7516a23
commit 74c9d7ace2
2 changed files with 55 additions and 43 deletions

View File

@@ -136,19 +136,25 @@ The agent table configures Telegraf and the defaults used across all plugins.
service input to set the timestamp at the appropriate precision.
- **debug**:
Run telegraf with debug log messages.
Log at debug level.
- **quiet**:
Run telegraf in quiet mode (error log messages only).
Log only error level messages.
- **logfile**:
Specify the log file name. The empty string means to log to stderr.
Log file name, the empty string means to log to stderr.
- **logfile_rotation_interval**:
Log file rotation time [interval][], e.g. "1d" means logs will rotated every day. Default is 0 => no rotation based on time.
The logfile will be rotated after the time interval specified. When set to
0 no time based rotation is performed.
- **logfile_rotation_max_size**:
The log file max [size][]. Log files will be rotated when they exceed this size. Default is 0 => no rotation based on file size.
The logfile will be rotated when it becomes larger than the specified size.
When set to 0 no size based rotation is performed.
- **logfile_rotation_max_archives**:
Maximum number of archives (rotated) files to keep. Older log files are deleted first.
This setting is only applicable if `logfile_rotation_interval` and/or `logfile_rotation_max_size` settings have been specified (otherwise there is no rotation)
Default is 0 => all rotated files are deleted. Use -1 to keep all archives.
Maximum number of rotated archives to keep, any older logs are deleted. If
set to -1, no archives are removed.
- **hostname**:
Override default hostname, if empty use os.Hostname()