Merge pull request #11 from randlabs/redesign

Improved syslog code and updates

Author: mxmauro

go.mod

@@ -4,5 +4,6 @@ go 1.13
 
 require (
 	github.com/gookit/color v1.5.0
-	golang.org/x/sys v0.0.0-20220408201424-a24fb2fb8a0f // indirect
+	github.com/randlabs/rundown-protection v1.0.4
+	golang.org/x/sys v0.0.0-20220412211240-33da011f77ad // indirect
 )

go.sum

@@ -4,14 +4,16 @@ github.com/gookit/color v1.5.0 h1:1Opow3+BWDwqor78DcJkJCIwnkviFi+rrOANki9BUFw=
 github.com/gookit/color v1.5.0/go.mod h1:43aQb+Zerm/BWh2GnrgOQm7ffz7tvQXEKV6BFMl7wAo=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/randlabs/rundown-protection v1.0.4 h1:rQuJf1+cKFsxqfFgcQuz7y+spqqKtDR4i2xeJZQ2gdQ=
+github.com/randlabs/rundown-protection v1.0.4/go.mod h1:rccYmsidTaGDOvZSAF9eYsLzMVvh9tj043JyTicfQ5o=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/xo/terminfo v0.0.0-20210125001918-ca9a967f8778 h1:QldyIu/L63oPpyvQmHgvgickp1Yw510KJOqX7H24mg8=
 github.com/xo/terminfo v0.0.0-20210125001918-ca9a967f8778/go.mod h1:2MuV+tbUrU1zIOPMxZ5EncGwgmMJsa+9ucAQZXxsObs=
 golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20220408201424-a24fb2fb8a0f h1:8w7RhxzTVgUzw/AH/9mUV5q0vMgy40SQRursCcfmkCw=
-golang.org/x/sys v0.0.0-20220408201424-a24fb2fb8a0f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220412211240-33da011f77ad h1:ntjMns5wyP/fN65tdBD4g8J5w8n015+iIIs9rtjXkY0=
+golang.org/x/sys v0.0.0-20220412211240-33da011f77ad/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=

internal/file/file.go

@@ -19,14 +19,6 @@ var newLine = "\n"
 
 //------------------------------------------------------------------------------
 
-// Options specifies the file logger settings to use when it is created.
-type Options struct {
-	Prefix       string `json:"prefix,omitempty"`
-	Directory    string `json:"dir,omitempty"`
-	DaysToKeep   uint   `json:"daysToKeep,omitempty"`
-	ErrorHandler ErrorHandler
-}
-
 // Logger is the object that controls file logging.
 type Logger struct {
 	mtx          sync.Mutex
@@ -39,6 +31,21 @@ type Logger struct {
 	errorHandler ErrorHandler
 }
 
+// Options specifies the file logger settings to use when it is created.
+type Options struct {
+	// Filename prefix to use when a file is created. Defaults to the binary name.
+	Prefix       string `json:"prefix,omitempty"`
+
+	// Destination directory to store log files.
+	Directory    string `json:"dir,omitempty"`
+
+	// Amount of days to keep old logs.
+	DaysToKeep   uint   `json:"daysToKeep,omitempty"`
+
+	// A callback to call if an internal error is encountered.
+	ErrorHandler ErrorHandler
+}
+
 // ErrorHandler is a callback to call if an internal error must be notified.
 type ErrorHandler func(message string)