package
7.17.28
Repository: https://github.com/elastic/beats.git
Documentation: pkg.go.dev

# Functions

GetOSState returns the FileStateOS for non windows systems.
Interval sets the time interval for log rotation in addition to log rotation by size.
IntervalLogIndex returns n as int given a log filename in the form [prefix]-[formattedDate]-n.
IsRemoved checks wheter the file held by f is removed.
Lstat returns a FileInfo describing the named file.
MaxBackups configures the maximum number of backup files to save (not counting the active file).
MaxSizeBytes configures the maximum number of bytes that a file should contain before being rotated.
NewFileRotator returns a new Rotator.
OrderIntervalLogs, when given a log filename in the form [prefix]-[formattedDate]-n returns the filename after zero-padding the trailing n so that foo-[date]-2 sorts before foo-[date]-10.
Permissions configures the file permissions to use for the file that the Rotator creates.
ReadOpen opens a file for reading only.
RedirectStandardError causes all standard error output to be directed to the given file.
RedirectStderr causes all writes to standard error to be redirected to this rotator.
RotateOnStartup immediately rotates files on startup rather than appending to the existing file.
SafeFileRotate safely rotates an existing file under path and replaces it with the tempfile.
Stat returns a FileInfo describing the named file.
Interval sets the time interval for log rotation in addition to log rotation by size.
SyncParent fsyncs parent directory.
WithLogger injects a logger implementation for logging debug information.
Wrap wraps the given os.FileInfo and returns a FileInfo in order to expose the UID and GID in a uniform manner across operating systems.

# Constants

MaxBackupsLimit is the upper bound on the number of backup files.

# Structs

Rotator is a io.WriteCloser that automatically rotates the file it is writing to when it reaches a maximum size and optionally on a time interval basis.

# Interfaces

A FileInfo describes a file and is returned by Stat and Lstat.
Logger allows the rotator to write debug information.

# Type aliases

RotatorOption is a configuration option for Rotator.