Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package hwlog
import (
"context"
"fmt"
"io"
"log"
"os"
"path"
"sync"
"time"
)
type CustomLoggerWriter struct {
writer io.Writer
mutex sync.Mutex
}
func NewCustomLoggerWriter(w io.Writer) *CustomLoggerWriter {
return &CustomLoggerWriter{
writer: w,
}
}
func (w *CustomLoggerWriter) Write(p []byte) (n int, err error) {
w.mutex.Lock()
defer w.mutex.Unlock()
now := time.Now()
timestamp := now.Format("2006-01-02 15:04:05.000000")
isDST := now.IsDST()
bufferSize := len(timestamp) + len(p) + 2
if isDST {
bufferSize += 3
}
buffer := make([]byte, 0, bufferSize)
buffer = append(buffer, '[')
buffer = append(buffer, timestamp...)
if isDST {
buffer = append(buffer, "DST"...)
}
buffer = append(buffer, ']')
buffer = append(buffer, p...)
return w.writer.Write(buffer)
}
const (
logDebugLv = iota - 1
logInfoLv
logWarnLv
logErrorLv
logCriticalLv
)
type logger struct {
lgDebug *log.Logger
lgInfo *log.Logger
lgWarn *log.Logger
lgError *log.Logger
lgCritical *log.Logger
lgCtrl *LogLimiter
lgLevel int
lgMaxLine int
}
func (lg *logger) initLogWriter(w io.Writer) {
customWriter := NewCustomLoggerWriter(w)
lg.lgDebug = log.New(customWriter, "[DEBUG] ", 0)
lg.lgInfo = log.New(customWriter, "[INFO] ", 0)
lg.lgWarn = log.New(customWriter, "[WARN] ", 0)
lg.lgError = log.New(customWriter, "[ERROR] ", 0)
lg.lgCritical = log.New(customWriter, "[CRITICAL] ", 0)
}
func (lg *logger) setLoggerLevel(lv int) {
if lv < minLogLevel || lv > maxLogLevel {
lg.lgLevel = 0
return
}
lg.lgLevel = lv
}
func (lg *logger) setLoggerMaxLine(lml int) {
if lml <= 0 || lml > maxEachLineLen {
lg.lgMaxLine = defaultMaxEachLineLen
return
}
lg.lgMaxLine = lml
}
func (lg *logger) setLoggerWriter(config *LogConfig) {
rollLogger := &Logs{
FileName: config.LogFileName,
Capacity: config.FileMaxSize,
SaveVolume: config.MaxBackups,
SaveTime: config.MaxAge,
}
logWriter := &LogLimiter{
Logs: rollLogger,
ExpiredTime: config.ExpiredTime,
CacheSize: config.CacheSize,
}
if config.OnlyToStdout {
lg.initLogWriter(os.Stdout)
return
}
if config.OnlyToFile {
lg.initLogWriter(logWriter)
return
}
writer := io.MultiWriter(os.Stdout, logWriter)
lg.initLogWriter(writer)
lg.lgCtrl = logWriter
}
func (lg *logger) setLogger(config *LogConfig) error {
if err := validateLogConfigFiled(config); err != nil {
return err
}
lg.setLoggerWriter(config)
lg.setLoggerLevel(config.LogLevel)
lg.setLoggerMaxLine(config.MaxLineLength)
msg := fmt.Sprintf("%s's logger init success", path.Base(config.LogFileName))
if config.OnlyToStdout {
msg = fmt.Sprintf("%s, only to stdout", msg)
return nil
}
lg.Info(msg)
if err := os.Chmod(config.LogFileName, LogFileMode); err != nil {
lg.Errorf("change file mode failed: %v", err)
return fmt.Errorf("set log file mode failed")
}
return nil
}
func (lg *logger) isInit() bool {
return lg.lgDebug != nil && lg.lgInfo != nil && lg.lgWarn != nil && lg.lgError != nil && lg.lgCritical != nil
}
func (lg *logger) Debug(args ...interface{}) {
lg.DebugWithCtx(nil, args...)
}
func (lg *logger) Debugf(format string, args ...interface{}) {
lg.DebugfWithCtx(nil, format, args...)
}
func (lg *logger) DebugWithCtx(ctx context.Context, args ...interface{}) {
if lg.lgLevel > logDebugLv {
return
}
if lg.validate() {
printHelper(lg.lgDebug, fmt.Sprint(args...), lg.lgMaxLine, ctx)
}
}
func (lg *logger) DebugfWithCtx(ctx context.Context, format string, args ...interface{}) {
if lg.lgLevel > logDebugLv {
return
}
if lg.validate() {
printHelper(lg.lgDebug, fmt.Sprintf(format, args...), lg.lgMaxLine, ctx)
}
}
func (lg *logger) Info(args ...interface{}) {
lg.InfoWithCtx(nil, args...)
}
func (lg *logger) Infof(format string, args ...interface{}) {
lg.InfofWithCtx(nil, format, args...)
}
func (lg *logger) InfoWithCtx(ctx context.Context, args ...interface{}) {
if lg.lgLevel > logInfoLv {
return
}
if lg.validate() {
printHelper(lg.lgInfo, fmt.Sprint(args...), lg.lgMaxLine, ctx)
}
}
func (lg *logger) InfofWithCtx(ctx context.Context, format string, args ...interface{}) {
if lg.lgLevel > logInfoLv {
return
}
if lg.validate() {
printHelper(lg.lgInfo, fmt.Sprintf(format, args...), lg.lgMaxLine, ctx)
}
}
func (lg *logger) Warn(args ...interface{}) {
lg.WarnWithCtx(nil, args...)
}
func (lg *logger) Warnf(format string, args ...interface{}) {
lg.WarnfWithCtx(nil, format, args...)
}
func (lg *logger) WarnWithCtx(ctx context.Context, args ...interface{}) {
if lg.lgLevel > logWarnLv {
return
}
if lg.validate() {
printHelper(lg.lgWarn, fmt.Sprint(args...), lg.lgMaxLine, ctx)
}
}
func (lg *logger) WarnfWithCtx(ctx context.Context, format string, args ...interface{}) {
if lg.lgLevel > logWarnLv {
return
}
if lg.validate() {
printHelper(lg.lgWarn, fmt.Sprintf(format, args...), lg.lgMaxLine, ctx)
}
}
func (lg *logger) WarnfWithLimit(domain string, id interface{}, format string, args ...interface{}) {
if needPrint, extraErrLog := IsNeedPrintWithSpecifiedCounts(domain, id, ProblemOccurMaxNumbers); needPrint {
format = fmt.Sprintf("%s %s", format, extraErrLog)
lg.WarnfWithCtx(nil, format, args...)
}
}
func (lg *logger) Error(args ...interface{}) {
lg.ErrorWithCtx(nil, args...)
}
func (lg *logger) Errorf(format string, args ...interface{}) {
lg.ErrorfWithCtx(nil, format, args...)
}
func (lg *logger) ErrorfWithLimit(domain string, id interface{}, format string, args ...interface{}) {
if needPrint, extraErrLog := IsNeedPrintWithSpecifiedCounts(domain, id, ProblemOccurMaxNumbers); needPrint {
format = fmt.Sprintf("%s %s", format, extraErrLog)
lg.ErrorfWithCtx(nil, format, args...)
}
}
func (lg *logger) ErrorfWithSpecifiedCounts(domain string, id interface{}, maxCounts int,
format string, args ...interface{}) {
if needPrint, extraErrLog := IsNeedPrintWithSpecifiedCounts(domain, id, maxCounts); needPrint {
format = fmt.Sprintf("%s %s", format, extraErrLog)
lg.ErrorfWithCtx(nil, format, args...)
}
}
func (lg *logger) ErrorWithCtx(ctx context.Context, args ...interface{}) {
if lg.lgLevel > logErrorLv {
return
}
if lg.validate() {
printHelper(lg.lgError, fmt.Sprint(args...), lg.lgMaxLine, ctx)
}
}
func (lg *logger) ErrorfWithCtx(ctx context.Context, format string, args ...interface{}) {
if lg.lgLevel > logErrorLv {
return
}
if lg.validate() {
printHelper(lg.lgError, fmt.Sprintf(format, args...), lg.lgMaxLine, ctx)
}
}
func (lg *logger) Critical(args ...interface{}) {
lg.CriticalWithCtx(nil, args...)
}
func (lg *logger) Criticalf(format string, args ...interface{}) {
lg.CriticalfWithCtx(nil, format, args...)
}
func (lg *logger) CriticalWithCtx(ctx context.Context, args ...interface{}) {
if lg.lgLevel > logCriticalLv {
return
}
if lg.validate() {
printHelper(lg.lgCritical, fmt.Sprint(args...), lg.lgMaxLine, ctx)
}
}
func (lg *logger) CriticalfWithCtx(ctx context.Context, format string, args ...interface{}) {
if lg.lgLevel > logCriticalLv {
return
}
if lg.validate() {
printHelper(lg.lgCritical, fmt.Sprintf(format, args...), lg.lgMaxLine, ctx)
}
}
func (lg *logger) validate() bool {
if lg == nil || !lg.isInit() {
fmt.Println("Fatal function's logger is nil")
return false
}
return true
}
func (lg *logger) FlushMem() error {
return lg.lgCtrl.Flush()
}