/
fileLogging.go
233 lines (190 loc) · 5.83 KB
/
fileLogging.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
package file
import (
"context"
"fmt"
"os"
"path/filepath"
"runtime"
"sync"
"time"
"github.com/Dharitri-org/drtg-core/core"
logger "github.com/Dharitri-org/drtg-logger"
"github.com/Dharitri-org/drtg-logger/redirects"
)
const (
defaultFileLifeSpan = time.Hour * 24
defaultFileSizeInMB = 1024 // 1GB
recheckFileSizeInterval = time.Second * 30
oneMegaByte = 1024 * 1024
minFileLifeSpan = time.Second
minSizeInMB = uint64(1)
maxSizeInMB = uint64(1024 * 1024) // 1TB
)
var log = logger.GetOrCreate("common/logging")
var trueCheckHandler = func() bool { return true }
type logLifeSpanner interface {
resetDuration(newDuration time.Duration)
reset()
close()
}
// fileLogging is able to rotate the log files
type fileLogging struct {
mutOperation sync.RWMutex
currentFile *os.File
workingDir string
defaultLogsPath string
logFilePrefix string
cancelFunc func()
mutIsClosed sync.Mutex
lifeSpanSize uint64
isClosed bool
timeBasedLogLifeSpanner logLifeSpanner
sizeBaseLogLifeSpanner logLifeSpanner
notifyChan chan struct{}
}
// ArgsFileLogging is the argument for the file logger
type ArgsFileLogging struct {
WorkingDir string
DefaultLogsPath string
LogFilePrefix string
}
// NewFileLogging creates a file log watcher used to break the log file into multiple smaller files
func NewFileLogging(args ArgsFileLogging) (*fileLogging, error) {
fl := &fileLogging{
workingDir: args.WorkingDir,
defaultLogsPath: args.DefaultLogsPath,
logFilePrefix: args.LogFilePrefix,
isClosed: false,
lifeSpanSize: defaultFileSizeInMB * oneMegaByte,
notifyChan: make(chan struct{}),
}
fl.timeBasedLogLifeSpanner = newLifeSpanner(fl.notifyChan, trueCheckHandler, defaultFileLifeSpan)
fl.sizeBaseLogLifeSpanner = newLifeSpanner(fl.notifyChan, fl.sizeReached, recheckFileSizeInterval)
fl.recreateLogFile()
// we need this function as to call file.Close() when the code panics and the deferred function associated
// with the file pointer in the main func will never be reached
runtime.SetFinalizer(fl, func(fileLogHandler *fileLogging) {
_ = fileLogHandler.currentFile.Close()
})
ctx, cancelFunc := context.WithCancel(context.Background())
go fl.autoRecreateFile(ctx)
fl.cancelFunc = cancelFunc
return fl, nil
}
func (fl *fileLogging) createFile() (*os.File, error) {
logDirectory := filepath.Join(fl.workingDir, fl.defaultLogsPath)
return core.CreateFile(
core.ArgCreateFileArgument{
Prefix: fl.logFilePrefix,
Directory: logDirectory,
FileExtension: "log",
},
)
}
func (fl *fileLogging) recreateLogFile() {
newFile, err := fl.createFile()
if err != nil {
log.Error("error creating new log file", "error", err)
return
}
fl.mutOperation.Lock()
defer fl.mutOperation.Unlock()
oldFile := fl.currentFile
err = logger.AddLogObserver(newFile, &logger.PlainFormatter{})
if err != nil {
log.Error("error adding log observer", "error", err)
return
}
errNotCritical := redirects.RedirectStderr(newFile)
log.LogIfError(errNotCritical, "step", "redirecting std error")
fl.currentFile = newFile
if oldFile == nil {
return
}
errNotCritical = oldFile.Close()
log.LogIfError(errNotCritical, "step", "closing old log file")
errNotCritical = logger.RemoveLogObserver(oldFile)
log.LogIfError(errNotCritical, "step", "removing old log observer")
fl.timeBasedLogLifeSpanner.reset()
}
func (fl *fileLogging) autoRecreateFile(ctx context.Context) {
for {
select {
case <-ctx.Done():
log.Debug("closing fileLogging.autoRecreateFile go routine")
return
case <-fl.notifyChan:
fl.recreateLogFile()
}
}
}
// ChangeFileLifeSpan changes the log file span
func (fl *fileLogging) ChangeFileLifeSpan(newDuration time.Duration, sizeInMB uint64) error {
err := checkArgs(newDuration, sizeInMB)
if err != nil {
return err
}
fl.mutIsClosed.Lock()
isClosed := fl.isClosed
fl.mutIsClosed.Unlock()
if isClosed {
return core.ErrFileLoggingProcessIsClosed
}
size := sizeInMB * oneMegaByte
fl.mutOperation.Lock()
fl.lifeSpanSize = size
fl.timeBasedLogLifeSpanner.resetDuration(newDuration)
fl.mutOperation.Unlock()
log.Debug("changed the log life span", "new duration", newDuration, "new size", core.ConvertBytes(size))
return nil
}
func checkArgs(lifeSpanDuration time.Duration, lifeSpanInMB uint64) error {
if lifeSpanDuration < minFileLifeSpan {
return fmt.Errorf("%w for the life span duration, minimum: %v, provided: %v",
errInvalidParameter, minFileLifeSpan, lifeSpanDuration)
}
if lifeSpanInMB < minSizeInMB {
return fmt.Errorf("%w for the life span in MB, minimum: %v, provided: %v",
errInvalidParameter, minSizeInMB, lifeSpanInMB)
}
if lifeSpanInMB > maxSizeInMB {
return fmt.Errorf("%w for the life span in MB, maximum: %v, provided: %v",
errInvalidParameter, maxSizeInMB, lifeSpanInMB)
}
return nil
}
func (fl *fileLogging) sizeReached() bool {
fl.mutOperation.RLock()
currentFile := fl.currentFile
fl.mutOperation.RUnlock()
if currentFile == nil {
return false
}
stats, errNotCritical := currentFile.Stat()
if errNotCritical != nil {
log.Warn("error retrieving log statistics", "error", errNotCritical)
return false
}
return stats.Size() >= int64(fl.lifeSpanSize)
}
// Close closes the file logging handler
func (fl *fileLogging) Close() error {
fl.mutIsClosed.Lock()
if fl.isClosed {
fl.mutIsClosed.Unlock()
return nil
}
fl.isClosed = true
fl.mutIsClosed.Unlock()
fl.mutOperation.Lock()
err := fl.currentFile.Close()
fl.mutOperation.Unlock()
fl.cancelFunc()
fl.sizeBaseLogLifeSpanner.close()
fl.timeBasedLogLifeSpanner.close()
return err
}
// IsInterfaceNil returns true if there is no value under the interface
func (fl *fileLogging) IsInterfaceNil() bool {
return fl == nil
}