gopkg/lumberjack
2
0
Fork 0
Code Activity

update readme

Browse Source
This commit is contained in:
Nate Finch
2014-06-15 06:59:40 -04:00
parent 1bb33e2fca
commit 1781f71455
1 changed files with 38 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+38 -37
View File
@@ -1,7 +1,7 @@
# lumberjack # lumberjack
Lumberjack is still a work in progress, use at your own risk. Lumberjack is a Go package for writing logs to rolling files.
Lumberjack is intended to be one part of a logging infrastructure. Lumberjack is intended to be one part of a logging infrastructure.
It is not an all-in-one solution, but instead is a pluggable It is not an all-in-one solution, but instead is a pluggable
@@ -19,13 +19,17 @@ into the SetOutput function when your application starts:
Dir: "/var/log/myapp/" Dir: "/var/log/myapp/"
NameFormat: time.RFC822+".log", NameFormat: time.RFC822+".log",
MaxSize: lumberjack.Gigabyte, MaxSize: lumberjack.Gigabyte,
Backups: 3, MaxBackups: 3,
MaxAge: lumberjack.Week * 4, MaxAge: lumberjack.Week * 4,
)) ))
Note that lumberjack assumes whatever is writing to it will use locks to Note that lumberjack assumes whatever is writing to it will use locks to
prevent concurrent writes. Lumberjack does not implement its own lock. prevent concurrent writes. Lumberjack does not implement its own lock.
Lumberjack also assumes that only one process is writing to the output files.
Using the same lumberjack configuration from multiple processes on the same
machine will result in improper behavior.
@@ -68,14 +72,15 @@ type Logger struct {
// rolled. It defaults to 100 megabytes. // rolled. It defaults to 100 megabytes.
MaxSize int64 MaxSize int64
// MaxAge is the maximum time to retain old log files. The default is not // MaxAge is the maximum time to retain old log files based on
// to remove old log files based on age. // FileInfo.ModTime. The default is not to remove old log files based on
// age.
MaxAge time.Duration MaxAge time.Duration
// Backups is the maximum number of old log files to retain. The default is // MaxBackups is the maximum number of old log files to retain. The default
// to retain all old log files (though MaxAge may still cause them to get // is to retain all old log files (though MaxAge may still cause them to get
// deleted.) // deleted.)
Backups int MaxBackups int
// LocalTime determines if the time used for formatting the filename is the // LocalTime determines if the time used for formatting the filename is the
// computer's local time. The default is to use UTC time. // computer's local time. The default is to use UTC time.
@@ -85,41 +90,31 @@ type Logger struct {
``` ```
Logger is an io.WriteCloser that writes to a log file in the given directory Logger is an io.WriteCloser that writes to a log file in the given directory
with the given NameFormat. NameFormat should include a time formatting with the given NameFormat. NameFormat should include a time formatting
layout in it that produces a valid filename for the OS. For more about time layout in it that produces a valid unique filename for the OS. For more
formatting layouts, read a href="http://golang.org/pkg/time/#pkg-constants">http://golang.org/pkg/time/#pkg-constants</a>. about time formatting layouts, read a href="http://golang.org/pkg/time/#pkg-">http://golang.org/pkg/time/#pkg-</a>
constants.
Logger opens or creates the logfile on first Write. If the most recently The date encoded in the filename by NameFormat is used to determine which log
modified file in the log file directory that matches the NameFormat is less files are most recent in several situations.
than MaxSize, that file will be appended to. If no file such exists, a new
file is created using the current time to generate the filename. Logger opens or creates a logfile on first Write. It looks for files in the
directory that match its name format, and if the one with the most recent
NameFormat date is less than MaxSize, it will open and append to that file.
If no such file exists, or the file is >= MaxSize, a new file is created
using the current time with NameFormat to generate the filename.
Whenever a write would cause the current log file exceed MaxSize, a new file Whenever a write would cause the current log file exceed MaxSize, a new file
is created using the current time. is created using the current time.
### Cleaning Up Old Log Files ### Cleaning Up Old Log Files
Whenever a new file gets created, old log files may be deleted. The log file Whenever a new file gets created, old log files may be deleted. The log file
directory is scanned for files that match NameFormat. The most recently directory is scanned for files that match NameFormat. The most recent files
modified files which are newer than MaxAge (up to a number of files equal to according to their NameFormat date will be retained, up to a number equal to
Backups) are retained, all other log files are deleted. MaxBackups (or all of them if MaxBackups is 0). Any files with a last
modified time (based on FileInfo.ModTime) older than MaxAge are deleted,
regardless of MaxBackups.
### Defaults If MaxBackups and MaxAge are both 0, no old log files will be deleted.
If Dir is empty, the files will be created in os.TempDir().
If NameFormat is empty, will be used as the
name format.
If MaxSize is 0, 100 megabytes will be used as the max size.
if MaxAge is 0, last modification time will not be used to delete old log
files.
If Backups is 0, there's no limit to the number of old log files that will be
retained, as long as they're newer than MaxAge.
If MaxAge and Backups are both 0, no old log files will be deteled.
Thus, an default lumberjack.Logger struct will log to os.TempDir() with a 100
megabyte max size and never delete old log files.
@@ -150,5 +145,11 @@ returned that satisfies IsWriteTooLong.
# License
MIT License
- - -
Generated by [godoc2md](http://godoc.org/github.com/davecheney/godoc2md)