Update docs, adding Compress setting details (#49)
This commit is contained in:
committed by
Nate Finch
parent
df99d62fd4
commit
aee4629129
@@ -37,6 +37,7 @@ log.SetOutput(&lumberjack.Logger{
|
|||||||
MaxSize: 500, // megabytes
|
MaxSize: 500, // megabytes
|
||||||
MaxBackups: 3,
|
MaxBackups: 3,
|
||||||
MaxAge: 28, //days
|
MaxAge: 28, //days
|
||||||
|
Compress: true, // disabled by default
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -70,6 +71,10 @@ type Logger struct {
|
|||||||
// backup files is the computer's local time. The default is to use UTC
|
// backup files is the computer's local time. The default is to use UTC
|
||||||
// time.
|
// time.
|
||||||
LocalTime bool `json:"localtime" yaml:"localtime"`
|
LocalTime bool `json:"localtime" yaml:"localtime"`
|
||||||
|
|
||||||
|
// Compress determines if the rotated log files should be compressed
|
||||||
|
// using gzip. The default is not to perform compression.
|
||||||
|
Compress bool `json:"compress" yaml:"compress"`
|
||||||
// contains filtered or unexported fields
|
// contains filtered or unexported fields
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -14,5 +14,6 @@ func Example() {
|
|||||||
MaxSize: 500, // megabytes
|
MaxSize: 500, // megabytes
|
||||||
MaxBackups: 3,
|
MaxBackups: 3,
|
||||||
MaxAge: 28, // days
|
MaxAge: 28, // days
|
||||||
|
Compress: true, // disabled by default
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
+1
-1
@@ -104,7 +104,7 @@ type Logger struct {
|
|||||||
LocalTime bool `json:"localtime" yaml:"localtime"`
|
LocalTime bool `json:"localtime" yaml:"localtime"`
|
||||||
|
|
||||||
// Compress determines if the rotated log files should be compressed
|
// Compress determines if the rotated log files should be compressed
|
||||||
// using gzip.
|
// using gzip. The default is not to perform compression.
|
||||||
Compress bool `json:"compress" yaml:"compress"`
|
Compress bool `json:"compress" yaml:"compress"`
|
||||||
|
|
||||||
size int64
|
size int64
|
||||||
|
|||||||
Reference in New Issue
Block a user