-
Notifications
You must be signed in to change notification settings - Fork 1
/
log.go
198 lines (186 loc) · 5.61 KB
/
log.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
/*
Author: Paul Côté
Last Change Author: Paul Côté
Last Date Changed: 2022/09/20
*/
package core
import (
"fmt"
"os"
"regexp"
"runtime"
"strconv"
"strings"
"github.com/SSSOC-CAN/laniakea/utils"
bg "github.com/SSSOCPaulCote/blunderguard"
"github.com/mattn/go-colorable"
color "github.com/mgutz/ansi"
"github.com/rs/zerolog"
)
const (
logFileRoot = "logfile"
logFileExt = "log"
logFileName = "logfile.log"
ErrLogLvlNotFound = bg.Error("log level not found")
)
// subLogger is a thin-wrapper for the `zerolog.Logger` struct
type subLogger struct {
SubLogger zerolog.Logger
Subsystem string
}
type moddedFileWriter struct {
File *os.File
maxFileSize int64 // MB
maxFiles int64
fileNameRoot string // must include path if not in current directory
fileExt string
pathToFile string
}
// Write Implements the io.Writer interface
func (w *moddedFileWriter) Write(p []byte) (n int, err error) {
stat, err := w.File.Stat()
if err != nil {
return 0, err
}
// Check if maximum file size if exceeded
if stat.Size() >= w.maxFileSize || stat.Size()+int64(len(p)) >= w.maxFileSize {
// get current file name number
r, err := regexp.Compile(fmt.Sprintf("%s([0-9]+)", w.fileNameRoot)) // may need file extension
if err != nil {
return 0, err
}
matches := r.FindStringSubmatch(stat.Name())
var (
fileNum int64
)
if len(matches) > 1 {
fileNum, err = strconv.ParseInt(matches[1], 10, 64)
if err != nil {
return 0, err
}
}
// Close current file and delete new file if it already exists
w.File.Close()
var newFileName string
if fileNum >= w.maxFiles-1 {
newFileName = fmt.Sprintf("%s.%s", w.fileNameRoot, w.fileExt)
} else {
newFileName = fmt.Sprintf("%s%v.%s", w.fileNameRoot, fileNum+int64(1), w.fileExt)
}
if utils.FileExists(fmt.Sprintf("%s/%s", w.pathToFile, newFileName)) {
err = os.Remove(fmt.Sprintf("%s/%s", w.pathToFile, newFileName))
if err != nil {
return 0, err
}
}
newFile, err := os.OpenFile(fmt.Sprintf("%s/%s", w.pathToFile, newFileName), os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0775)
if err != nil {
return 0, err
}
w.File = newFile
}
return w.File.Write(p)
}
// log_level is a mapping of log levels as strings to structs from the zerolog package
var log_level = map[string]zerolog.Level{
"INFO": zerolog.InfoLevel,
"PANIC": zerolog.PanicLevel,
"FATAL": zerolog.FatalLevel,
"ERROR": zerolog.ErrorLevel,
"DEBUG": zerolog.DebugLevel,
"TRACE": zerolog.TraceLevel,
}
// InitLogger creates a new instance of the `zerolog.Logger` type. If `console_out` is true, it will output the logs to the console as well as the logfile
func InitLogger(config *Config) (zerolog.Logger, error) {
// check to see if log file exists. If not, create one
var (
log_file *os.File
err error
logger zerolog.Logger
)
log_file, err = os.OpenFile(config.LogFileDir+"/"+logFileName, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0775)
if err != nil {
// try to create the .laniakea dir and try again if log dir is default log dir
if config.DefaultLogDir {
err = os.Mkdir(config.LogFileDir, 0775)
if err != nil {
return logger, err
}
log_file, err = os.OpenFile(config.LogFileDir+"/logfile.log", os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0775)
if err != nil {
return logger, err
}
} else {
return logger, err
}
}
// use new modified writer
modded_file := &moddedFileWriter{
File: log_file,
maxFileSize: config.MaxLogFileSize * 1000000, // converting to Bytes
maxFiles: config.MaxLogFiles,
fileNameRoot: logFileRoot,
fileExt: logFileExt,
pathToFile: config.LogFileDir,
}
if config.ConsoleOutput {
output := zerolog.NewConsoleWriter()
if runtime.GOOS == "windows" {
output.Out = colorable.NewColorableStdout()
} else {
output.Out = os.Stderr
}
output.FormatLevel = func(i interface{}) string {
var msg string
switch v := i.(type) {
default:
x := fmt.Sprintf("%v", v)
switch x {
case "info":
msg = color.Color(strings.ToUpper("["+x+"]"), "green")
case "panic":
msg = color.Color(strings.ToUpper("["+x+"]"), "red")
case "fatal":
msg = color.Color(strings.ToUpper("["+x+"]"), "red")
case "error":
msg = color.Color(strings.ToUpper("["+x+"]"), "red")
case "warn":
msg = color.Color(strings.ToUpper("["+x+"]"), "yellow")
case "debug":
msg = color.Color(strings.ToUpper("["+x+"]"), "yellow")
case "trace":
msg = color.Color(strings.ToUpper("["+x+"]"), "magenta")
}
}
return msg + fmt.Sprintf("\t")
}
multi := zerolog.MultiLevelWriter(output, modded_file)
logger = zerolog.New(multi).With().Timestamp().Logger()
} else {
logger = zerolog.New(modded_file).With().Timestamp().Logger()
}
return logger, nil
}
// NewSubLogger takes a `zerolog.Logger` and string for the name of the subsystem and creates a `subLogger` for this subsystem
func NewSubLogger(l *zerolog.Logger, subsystem string) *subLogger {
sub := l.With().Str("subsystem", subsystem).Logger()
s := subLogger{
SubLogger: sub,
Subsystem: subsystem,
}
return &s
}
// LogWithErrors is a method which takes a log level and message as a string and writes the corresponding log. Returns an error if the log level doesn't exist
func (s subLogger) LogWithErrors(level, msg string) error {
if lvl, ok := log_level[level]; ok {
s.SubLogger.WithLevel(lvl).Msg(msg)
return nil
} else {
s.SubLogger.Error().Msgf("Log level %v not found.", level)
return ErrLogLvlNotFound
}
}
// Log is a method which takes a log level and message as a string and writes the corresponding log.
func (s subLogger) Log(level, msg string) {
_ = s.LogWithErrors(level, msg)
}