Documentation
¶
Index ¶
- Constants
- func RedirectStandardError(toFile *os.File) error
- func SafeFileRotate(path, tempfile string) error
- func SyncParent(path string) error
- type FileInfo
- type Logger
- type Rotator
- type RotatorOption
- func Extension(ext string) RotatorOption
- func Interval(d time.Duration) RotatorOption
- func MaxBackups(n uint) RotatorOption
- func MaxSizeBytes(n uint) RotatorOption
- func Permissions(m os.FileMode) RotatorOption
- func RedirectStderr(redirect bool) RotatorOption
- func RotateOnStartup(b bool) RotatorOption
- func WithClock(clock clock) RotatorOption
- func WithLogger(l Logger) RotatorOption
Constants ¶
const ( // MaxBackupsLimit is the upper bound on the number of backup files. Any values // greater will result in an error. MaxBackupsLimit = 1024 DateFormat = "20060102" )
Variables ¶
This section is empty.
Functions ¶
func RedirectStandardError ¶
RedirectStandardError causes all standard error output to be directed to the given file.
func SafeFileRotate ¶
SafeFileRotate safely rotates an existing file under path and replaces it with the tempfile
func SyncParent ¶ added in v0.1.2
SyncParent fsyncs parent directory
Types ¶
type FileInfo ¶
type FileInfo interface {
os.FileInfo
UID() (int, error) // UID of the file owner. Returns an error on non-POSIX file systems.
GID() (int, error) // GID of the file owner. Returns an error on non-POSIX file systems.
}
A FileInfo describes a file and is returned by Stat and Lstat.
func Lstat ¶
Lstat returns a FileInfo describing the named file. If the file is a symbolic link, the returned FileInfo describes the symbolic link. Lstat makes no attempt to follow the link. If there is an error, it will be of type *PathError.
type Logger ¶
type Logger interface {
Debugw(msg string, keysAndValues ...interface{}) // Debug
}
Logger allows the rotator to write debug information.
type Rotator ¶
type Rotator struct {
// contains filtered or unexported fields
}
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. It also purges the oldest rotated files when the maximum number of backups is reached.
func NewFileRotator ¶
func NewFileRotator(filename string, options ...RotatorOption) (*Rotator, error)
NewFileRotator returns a new Rotator.
type RotatorOption ¶
type RotatorOption func(r *Rotator)
RotatorOption is a configuration option for Rotator.
func Extension ¶ added in v0.2.10
func Extension(ext string) RotatorOption
Extension configures the file extension to use for the log file. The default is "ndjson".
func Interval ¶
func Interval(d time.Duration) RotatorOption
Interval sets the time interval for log rotation in addition to log rotation by size. The default is 0 for disabled.
func MaxBackups ¶
func MaxBackups(n uint) RotatorOption
MaxBackups configures the maximum number of backup files to save (not counting the active file). The upper limit is 1024 on this value is. The default is 7.
func MaxSizeBytes ¶
func MaxSizeBytes(n uint) RotatorOption
MaxSizeBytes configures the maximum number of bytes that a file should contain before being rotated. The default is 10 MiB.
func Permissions ¶
func Permissions(m os.FileMode) RotatorOption
Permissions configures the file permissions to use for the file that the Rotator creates. The default is 0600.
func RedirectStderr ¶
func RedirectStderr(redirect bool) RotatorOption
RedirectStderr causes all writes to standard error to be redirected to this rotator.
func RotateOnStartup ¶
func RotateOnStartup(b bool) RotatorOption
RotateOnStartup immediately rotates files on startup rather than appending to the existing file. The default is true.
func WithClock ¶
func WithClock(clock clock) RotatorOption
func WithLogger ¶
func WithLogger(l Logger) RotatorOption
WithLogger injects a logger implementation for logging debug information. If no logger is injected then the no logging will occur.
Source Files