Repository navigation
Expand file tree
/
Copy pathglog_logger.go
More file actions
308 lines (287 loc) · 8.09 KB
/
Copy pathglog_logger.go
File metadata and controls
308 lines (287 loc) · 8.09 KB
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
// Copyright 2017 gf Author(https://github.com/gogf/gf). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package glog
import (
"bytes"
"context"
"fmt"
"github.com/gogf/gf/internal/intlog"
"github.com/gogf/gf/os/gfpool"
"github.com/gogf/gf/os/gmlock"
"github.com/gogf/gf/os/gtimer"
"io"
"os"
"strings"
"sync"
"time"
"github.com/gogf/gf/debug/gdebug"
"github.com/gogf/gf/os/gfile"
"github.com/gogf/gf/os/gtime"
"github.com/gogf/gf/text/gregex"
"github.com/gogf/gf/util/gconv"
)
// Logger is the struct for logging management.
type Logger struct {
rmu sync.Mutex // Mutex for rotation feature.
ctx context.Context // Context for logging.
parent *Logger // Parent logger, if it is not empty, it means the logger is used in chaining function.
config Config // Logger configuration.
}
const (
gDEFAULT_FILE_FORMAT = `{Y-m-d}.log`
gDEFAULT_FILE_FLAGS = os.O_CREATE | os.O_WRONLY | os.O_APPEND
gDEFAULT_FILE_PERM = os.FileMode(0666)
gDEFAULT_FILE_EXPIRE = time.Minute
gPATH_FILTER_KEY = "/os/glog/glog"
)
const (
F_ASYNC = 1 << iota // Print logging content asynchronously。
F_FILE_LONG // Print full file name and line number: /a/b/c/d.go:23.
F_FILE_SHORT // Print final file name element and line number: d.go:23. overrides F_FILE_LONG.
F_TIME_DATE // Print the date in the local time zone: 2009-01-23.
F_TIME_TIME // Print the time in the local time zone: 01:23:23.
F_TIME_MILLI // Print the time with milliseconds in the local time zone: 01:23:23.675.
F_CALLER_FN // Print Caller function name and package: main.main
F_TIME_STD = F_TIME_DATE | F_TIME_MILLI
)
// New creates and returns a custom logger.
func New() *Logger {
logger := &Logger{
config: DefaultConfig(),
}
// Initialize the internal handler after some delay.
gtimer.AddOnce(time.Second, func() {
gtimer.AddOnce(logger.config.RotateCheckInterval, logger.rotateChecksTimely)
})
return logger
}
// NewWithWriter creates and returns a custom logger with io.Writer.
func NewWithWriter(writer io.Writer) *Logger {
l := New()
l.SetWriter(writer)
return l
}
// Clone returns a new logger, which is the clone the current logger.
// It's commonly used for chaining operations.
func (l *Logger) Clone() *Logger {
logger := Logger{}
logger = *l
logger.parent = l
return &logger
}
// getFilePath returns the logging file path.
// The logging file name must have extension name of "log".
func (l *Logger) getFilePath(now time.Time) string {
// Content containing "{}" in the file name is formatted using gtime.
file, _ := gregex.ReplaceStringFunc(`{.+?}`, l.config.File, func(s string) string {
return gtime.New(now).Format(strings.Trim(s, "{}"))
})
file = gfile.Join(l.config.Path, file)
if gfile.ExtName(file) != "log" {
file += ".log"
}
return file
}
// print prints <s> to defined writer, logging file or passed <std>.
func (l *Logger) print(std io.Writer, lead string, values ...interface{}) {
var (
now = time.Now()
buffer = bytes.NewBuffer(nil)
)
if l.config.HeaderPrint {
// Time.
timeFormat := ""
if l.config.Flags&F_TIME_DATE > 0 {
timeFormat += "2006-01-02 "
}
if l.config.Flags&F_TIME_TIME > 0 {
timeFormat += "15:04:05 "
}
if l.config.Flags&F_TIME_MILLI > 0 {
timeFormat += "15:04:05.000 "
}
if len(timeFormat) > 0 {
buffer.WriteString(now.Format(timeFormat))
}
// Lead string.
if len(lead) > 0 {
buffer.WriteString(lead)
if len(values) > 0 {
buffer.WriteByte(' ')
}
}
// Caller path and Fn name.
if l.config.Flags&(F_FILE_LONG|F_FILE_SHORT|F_CALLER_FN) > 0 {
callerPath := ""
callerFnName, path, line := gdebug.CallerWithFilter(gPATH_FILTER_KEY, l.config.StSkip)
if l.config.Flags&F_CALLER_FN > 0 {
buffer.WriteString(fmt.Sprintf(`[%s] `, callerFnName))
}
if l.config.Flags&F_FILE_LONG > 0 {
callerPath = fmt.Sprintf(`%s:%d: `, path, line)
}
if l.config.Flags&F_FILE_SHORT > 0 {
callerPath = fmt.Sprintf(`%s:%d: `, gfile.Basename(path), line)
}
buffer.WriteString(callerPath)
}
// Prefix.
if len(l.config.Prefix) > 0 {
buffer.WriteString(l.config.Prefix + " ")
}
}
// Convert value to string.
var (
tempStr = ""
valueStr = ""
)
// Context values.
if l.ctx != nil && len(l.config.CtxKeys) > 0 {
ctxStr := ""
for _, key := range l.config.CtxKeys {
if v := l.ctx.Value(key); v != nil {
if ctxStr != "" {
ctxStr += ", "
}
ctxStr += fmt.Sprintf("%s: %+v", key, v)
}
}
if ctxStr != "" {
buffer.WriteString(fmt.Sprintf("{%s} ", ctxStr))
}
}
for _, v := range values {
if err, ok := v.(error); ok {
tempStr = fmt.Sprintf("%+v", err)
} else {
tempStr = gconv.String(v)
}
if len(valueStr) > 0 {
if valueStr[len(valueStr)-1] == '\n' {
// Remove one blank line(\n\n).
if tempStr[0] == '\n' {
valueStr += tempStr[1:]
} else {
valueStr += tempStr
}
} else {
valueStr += " " + tempStr
}
} else {
valueStr = tempStr
}
}
buffer.WriteString(valueStr + "\n")
if l.config.Flags&F_ASYNC > 0 {
err := asyncPool.Add(func() {
l.printToWriter(now, std, buffer)
})
if err != nil {
intlog.Error(err)
}
} else {
l.printToWriter(now, std, buffer)
}
}
// printToWriter writes buffer to writer.
func (l *Logger) printToWriter(now time.Time, std io.Writer, buffer *bytes.Buffer) {
if l.config.Writer == nil {
// Output content to disk file.
if l.config.Path != "" {
l.printToFile(now, buffer)
}
// Allow output to stdout?
if l.config.StdoutPrint {
if _, err := std.Write(buffer.Bytes()); err != nil {
intlog.Error(err)
}
}
} else {
if _, err := l.config.Writer.Write(buffer.Bytes()); err != nil {
panic(err)
}
}
}
// printToFile outputs logging content to disk file.
func (l *Logger) printToFile(now time.Time, buffer *bytes.Buffer) {
var (
logFilePath = l.getFilePath(now)
memoryLockKey = "glog.file.lock:" + logFilePath
)
gmlock.Lock(memoryLockKey)
defer gmlock.Unlock(memoryLockKey)
file := l.getFilePointer(logFilePath)
// Rotation file size checks.
if l.config.RotateSize > 0 {
stat, err := file.Stat()
if err != nil {
file.Close()
panic(err)
}
if stat.Size() > l.config.RotateSize {
l.rotateFileBySize(now)
file = l.getFilePointer(logFilePath)
}
}
if _, err := file.Write(buffer.Bytes()); err != nil {
file.Close()
panic(err)
}
file.Close()
}
// getFilePointer retrieves and returns a file pointer from file pool.
func (l *Logger) getFilePointer(path string) *gfpool.File {
file, err := gfpool.Open(
path,
gDEFAULT_FILE_FLAGS,
gDEFAULT_FILE_PERM,
gDEFAULT_FILE_EXPIRE,
)
if err != nil {
panic(err)
}
return file
}
// printStd prints content <s> without stack.
func (l *Logger) printStd(lead string, value ...interface{}) {
l.print(os.Stdout, lead, value...)
}
// printStd prints content <s> with stack check.
func (l *Logger) printErr(lead string, value ...interface{}) {
if l.config.StStatus == 1 {
if s := l.GetStack(); s != "" {
value = append(value, "\nStack:\n"+s)
}
}
// In matter of sequence, do not use stderr here, but use the same stdout.
l.print(os.Stdout, lead, value...)
}
// format formats <values> using fmt.Sprintf.
func (l *Logger) format(format string, value ...interface{}) string {
return fmt.Sprintf(format, value...)
}
// PrintStack prints the caller stack,
// the optional parameter <skip> specify the skipped stack offset from the end point.
func (l *Logger) PrintStack(skip ...int) {
if s := l.GetStack(skip...); s != "" {
l.Println("Stack:\n" + s)
} else {
l.Println()
}
}
// GetStack returns the caller stack content,
// the optional parameter <skip> specify the skipped stack offset from the end point.
func (l *Logger) GetStack(skip ...int) string {
stackSkip := l.config.StSkip
if len(skip) > 0 {
stackSkip += skip[0]
}
filters := []string{gPATH_FILTER_KEY}
if l.config.StFilter != "" {
filters = append(filters, l.config.StFilter)
}
return gdebug.StackWithFilters(filters, stackSkip)
}