Skip to content

Commit be0377b

Browse files
pnguyen215pnguyen215
committed
♻️ refactor: updated logger #9 
1 parent 54565f2 commit be0377b

File tree

2 files changed

+33
-33
lines changed

2 files changed

+33
-33
lines changed

‎logger/logger.go

+24-24
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ func (l *Logger) NewInstance() *logrus.Logger {
5757
if strings.EqualFold(LoggerTextFormatter, l.Formatter) {
5858
logger.SetFormatter(l.TextFormatter())
5959
}
60-
if l.AllowSnapshot {
60+
if l.PermitSnapshot {
6161
logger.SetFormatter(l.JsonFormatter())
6262
}
6363
logger.AddHook(l.TextHook())
@@ -117,13 +117,13 @@ func (l *Logger) TextFormatter() *logrus.TextFormatter {
117117
func (l *Logger) Config() *lumberjack.Logger {
118118
LoggerValidator(l)
119119
j := &lumberjack.Logger{}
120-
if l.AllowSnapshot {
120+
if l.PermitSnapshot {
121121
j.Filename = l.Filename
122122
j.MaxSize = l.MaxSize
123-
j.MaxBackups = l.MaxBackups
123+
j.MaxBackups = l.MaxBackup
124124
j.MaxAge = l.MaxAge
125125
j.Compress = l.Compress
126-
j.LocalTime = l.AllowLocalTime
126+
j.LocalTime = l.PermitLocalTime
127127
}
128128
return j
129129
}
@@ -140,7 +140,7 @@ func (l *Logger) ApplyConfig() *Logger {
140140
if strings.EqualFold(LoggerTextFormatter, l.Formatter) {
141141
l.instance.SetFormatter(l.TextFormatter())
142142
}
143-
if l.AllowSnapshot {
143+
if l.PermitSnapshot {
144144
l.instance.SetFormatter(l.JsonFormatter())
145145
}
146146
l.ResetLogger()
@@ -162,12 +162,12 @@ func (l *Logger) SetEnabled(value bool) *Logger {
162162
}
163163

164164
func (l *Logger) SetAllowSnapshot(value bool) *Logger {
165-
l.AllowSnapshot = value
165+
l.PermitSnapshot = value
166166
return l
167167
}
168168

169169
func (l *Logger) SetAllowLocalTime(value bool) *Logger {
170-
l.AllowLocalTime = value
170+
l.PermitLocalTime = value
171171
return l
172172
}
173173

@@ -177,7 +177,7 @@ func (l *Logger) SetCompress(value bool) *Logger {
177177
}
178178

179179
func (l *Logger) SetFilename(value string) *Logger {
180-
if l.AllowSnapshot {
180+
if l.PermitSnapshot {
181181
if utils.IsEmpty(value) {
182182
log.Panic("Filename is required")
183183
}
@@ -189,7 +189,7 @@ func (l *Logger) SetFilename(value string) *Logger {
189189
}
190190

191191
func (l *Logger) SetMaxSize(value int) *Logger {
192-
if l.AllowSnapshot {
192+
if l.PermitSnapshot {
193193
if value < 0 {
194194
log.Panic("Invalid max-size")
195195
}
@@ -199,7 +199,7 @@ func (l *Logger) SetMaxSize(value int) *Logger {
199199
}
200200

201201
func (l *Logger) SetMaxAge(value int) *Logger {
202-
if l.AllowSnapshot {
202+
if l.PermitSnapshot {
203203
if value <= 0 {
204204
log.Panic("Invalid max-age")
205205
}
@@ -209,12 +209,12 @@ func (l *Logger) SetMaxAge(value int) *Logger {
209209
}
210210

211211
func (l *Logger) SetMaxBackups(value int) *Logger {
212-
if l.AllowSnapshot {
212+
if l.PermitSnapshot {
213213
if value <= 0 {
214214
log.Panic("Invalid max-backups")
215215
}
216216
}
217-
l.MaxBackups = value
217+
l.MaxBackup = value
218218
return l
219219
}
220220

@@ -226,7 +226,7 @@ func (l *Logger) SetFormatter(value string) *Logger {
226226
}
227227

228228
func (l *Logger) SetAllowCaller(value bool) *Logger {
229-
l.AllowCaller = value
229+
l.PermitCaller = value
230230
return l
231231
}
232232

@@ -241,7 +241,7 @@ func LoggerValidator(l *Logger) {
241241
l.
242242
SetMaxSize(l.MaxSize).
243243
SetMaxAge(l.MaxAge).
244-
SetMaxBackups(l.MaxBackups).
244+
SetMaxBackups(l.MaxBackup).
245245
SetFilename(l.Filename)
246246
}
247247

@@ -294,7 +294,7 @@ func (l *Logger) Info(message string, params ...interface{}) {
294294
if strings.Contains(message, "%") {
295295
fields = make(logrus.Fields, (len(params)/2)+1)
296296
fields[LoggerMessageField] = fmt.Sprintf(message, params...)
297-
if l.AllowCaller {
297+
if l.PermitCaller {
298298
fields[LoggerCallerField] = fmt.Sprintf("%s:%d", filename, line)
299299
}
300300
for i := 0; i < len(params); i += 2 {
@@ -310,7 +310,7 @@ func (l *Logger) Info(message string, params ...interface{}) {
310310
} else {
311311
fields = make(logrus.Fields, 1)
312312
fields[LoggerMessageField] = message
313-
if l.AllowCaller {
313+
if l.PermitCaller {
314314
fields[LoggerCallerField] = fmt.Sprintf("%s:%d", filename, line)
315315
}
316316
for i := 0; i < len(params); i += 2 {
@@ -347,7 +347,7 @@ func (l *Logger) Error(message string, err error, params ...interface{}) {
347347
if strings.Contains(message, "%") {
348348
fields = make(logrus.Fields, (len(params)/2)+2)
349349
fields[LoggerMessageField] = fmt.Sprintf(message, params...)
350-
if l.AllowCaller {
350+
if l.PermitCaller {
351351
fields[LoggerCallerField] = fmt.Sprintf("%s:%d", filename, line)
352352
}
353353
if err != nil {
@@ -366,7 +366,7 @@ func (l *Logger) Error(message string, err error, params ...interface{}) {
366366
} else {
367367
fields = make(logrus.Fields, 2)
368368
fields[LoggerMessageField] = message
369-
if l.AllowCaller {
369+
if l.PermitCaller {
370370
fields[LoggerCallerField] = fmt.Sprintf("%s:%d", filename, line)
371371
}
372372
if err != nil {
@@ -406,7 +406,7 @@ func (l *Logger) Warn(message string, params ...interface{}) {
406406
if strings.Contains(message, "%") {
407407
fields = make(logrus.Fields, (len(params)/2)+1)
408408
fields[LoggerMessageField] = fmt.Sprintf(message, params...)
409-
if l.AllowCaller {
409+
if l.PermitCaller {
410410
fields[LoggerCallerField] = fmt.Sprintf("%s:%d", filename, line)
411411
}
412412
for i := 0; i < len(params); i += 2 {
@@ -422,7 +422,7 @@ func (l *Logger) Warn(message string, params ...interface{}) {
422422
} else {
423423
fields = make(logrus.Fields, 1)
424424
fields[LoggerMessageField] = message
425-
if l.AllowCaller {
425+
if l.PermitCaller {
426426
fields[LoggerCallerField] = fmt.Sprintf("%s:%d", filename, line)
427427
}
428428
for i := 0; i < len(params); i += 2 {
@@ -459,7 +459,7 @@ func (l *Logger) Debug(message string, params ...interface{}) {
459459
if strings.Contains(message, "%") {
460460
fields = make(logrus.Fields, (len(params)/2)+1)
461461
fields[LoggerMessageField] = fmt.Sprintf(message, params...)
462-
if l.AllowCaller {
462+
if l.PermitCaller {
463463
fields[LoggerCallerField] = fmt.Sprintf("%s:%d", filename, line)
464464
}
465465
for i := 0; i < len(params); i += 2 {
@@ -475,7 +475,7 @@ func (l *Logger) Debug(message string, params ...interface{}) {
475475
} else {
476476
fields = make(logrus.Fields, 1)
477477
fields[LoggerMessageField] = message
478-
if l.AllowCaller {
478+
if l.PermitCaller {
479479
fields[LoggerCallerField] = fmt.Sprintf("%s:%d", filename, line)
480480
}
481481
for i := 0; i < len(params); i += 2 {
@@ -513,7 +513,7 @@ func (l *Logger) Success(message string, params ...interface{}) {
513513
fields = make(logrus.Fields, (len(params)/2)+2)
514514
fields[LoggerMessageField] = fmt.Sprintf(message, params...)
515515
fields[LoggerSuccessField] = true
516-
if l.AllowCaller {
516+
if l.PermitCaller {
517517
fields[LoggerCallerField] = fmt.Sprintf("%s:%d", filename, line)
518518
}
519519
for i := 0; i < len(params); i += 2 {
@@ -530,7 +530,7 @@ func (l *Logger) Success(message string, params ...interface{}) {
530530
fields = make(logrus.Fields, 2)
531531
fields[LoggerMessageField] = message
532532
fields[LoggerSuccessField] = true
533-
if l.AllowCaller {
533+
if l.PermitCaller {
534534
fields[LoggerCallerField] = fmt.Sprintf("%s:%d", filename, line)
535535
}
536536
for i := 0; i < len(params); i += 2 {

‎logger/logger_model.go

+9-9
Original file line numberDiff line numberDiff line change
@@ -41,34 +41,34 @@ type Logger struct {
4141
// Enable to allow using logger
4242
IsEnabled bool `json:"enabled" yaml:"enabled"`
4343
// Allow to save log into file
44-
AllowSnapshot bool `json:"allow_snapshot" yaml:"allow-snapshot"`
45-
// AllowLocalTime determines if the time used for formatting the timestamps in
44+
PermitSnapshot bool `json:"permit_snapshot" yaml:"permit_snapshot"`
45+
// PermitLocalTime determines if the time used for formatting the timestamps in
4646
// backup files is the computer's local time. The default is to use UTC
4747
// time.
48-
AllowLocalTime bool `json:"allow_local_time" yaml:"allow-local-time"`
48+
PermitLocalTime bool `json:"permit_local_time" yaml:"permit_local_time"`
4949
// Compress determines if the rotated log files should be compressed
5050
// using gzip. The default is not to perform compression.
5151
Compress bool `json:"compress" yaml:"compress"`
5252
// Allow show caller detail, just like this: @caller=logger.go:487
53-
AllowCaller bool `json:"allow_caller" yaml:"allow-caller"`
53+
PermitCaller bool `json:"permit_caller" yaml:"permit_caller"`
5454
// Filename is the file to write logs to. Backup log files will be retained
5555
// in the same directory. It uses <process_name>-lumberjack.log in
5656
// os.TempDir() if empty.
5757
Filename string `json:"filename" yaml:"filename"`
5858
// MaxSize is the maximum size in megabytes of the log file before it gets
5959
// rotated. It defaults to 100 megabytes.
60-
MaxSize int `json:"max_size" yaml:"max-size"`
60+
MaxSize int `json:"max_size" yaml:"max_size"`
6161
// MaxAge is the maximum number of days to retain old log files based on the
6262
// timestamp encoded in their filename. Note that a day is defined as 24
6363
// hours and may not exactly correspond to calendar days due to daylight
6464
// savings, leap seconds, etc. The default is not to remove old log files
6565
// based on age.
66-
MaxAge int `json:"max_age" yaml:"max-age"`
67-
// MaxBackups is the maximum number of old log files to retain. The default
66+
MaxAge int `json:"max_age" yaml:"max_age"`
67+
// MaxBackup is the maximum number of old log files to retain. The default
6868
// is to retain all old log files (though MaxAge may still cause them to get
6969
// deleted.)
70-
MaxBackups int `json:"max_backups" yaml:"max-backups"`
71-
Formatter string `json:"formatter" yaml:"formatter"`
70+
MaxBackup int `json:"max_backup" yaml:"max_backup"`
71+
Formatter string `json:"formatter" yaml:"formatter"`
7272
}
7373

7474
type TextFormatterHook struct {

0 commit comments

Comments
 (0)