✨ Refactor logging implementation by removing the custom logging utility and transitioning to direct usage of the Zap logger. Update logger configuration in the development environment and clean up related files, including the removal of unused logger configuration JSON. Ensure consistent logging practices across the application.
This commit is contained in:
windyboy
@@ -1,177 +0,0 @@
|
||||
package utils
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
"strings"
|
||||
|
||||
"go.uber.org/zap"
|
||||
"go.uber.org/zap/zapcore"
|
||||
"gopkg.in/natefinch/lumberjack.v2"
|
||||
)
|
||||
|
||||
const (
|
||||
TestConfigFileName = "./configs/logger.test.json"
|
||||
ProdConfigFileName = "./configs/logger.json"
|
||||
DevelopmentConfigFileName = "./configs/logger.dev.json"
|
||||
EnvTest = "test"
|
||||
EnvProd = "prod"
|
||||
EnvDev = "dev"
|
||||
)
|
||||
|
||||
type LoggerConfig struct {
|
||||
ZapConfig zap.Config `json:"zapConfig"`
|
||||
LumberjackConfig LumberjackConfig `json:"lumberjackConfig"`
|
||||
}
|
||||
|
||||
type LumberjackConfig struct {
|
||||
Filename string `json:"filename"`
|
||||
MaxSize int `json:"maxSize"`
|
||||
MaxBackups int `json:"maxBackups"`
|
||||
MaxAge int `json:"maxAge"`
|
||||
Compress bool `json:"compress"`
|
||||
}
|
||||
|
||||
var (
|
||||
sugar *zap.SugaredLogger
|
||||
log *zap.Logger
|
||||
rootDir = detectRootDir()
|
||||
)
|
||||
|
||||
func detectRootDir() string {
|
||||
_, file, _, ok := runtime.Caller(0)
|
||||
if !ok {
|
||||
return "."
|
||||
}
|
||||
// pkg/utils/log.go -> project root
|
||||
return filepath.Clean(filepath.Join(filepath.Dir(file), "..", ".."))
|
||||
}
|
||||
|
||||
func load() {
|
||||
if log == nil {
|
||||
env := getEnv()
|
||||
// fmt.Printf("Environment: %s\n", env)
|
||||
configFile := getConfigFile(env)
|
||||
|
||||
config, err := loadConfig(configFile)
|
||||
if err != nil {
|
||||
fmt.Printf("Error loading config: %v\n", err)
|
||||
log, _ = zap.NewDevelopment()
|
||||
sugar = log.Sugar()
|
||||
return
|
||||
}
|
||||
|
||||
var logWriter zapcore.WriteSyncer
|
||||
if env == EnvProd {
|
||||
logWriter = zapcore.AddSync(&lumberjack.Logger{
|
||||
Filename: config.LumberjackConfig.Filename,
|
||||
MaxSize: config.LumberjackConfig.MaxSize,
|
||||
MaxBackups: config.LumberjackConfig.MaxBackups,
|
||||
MaxAge: config.LumberjackConfig.MaxAge,
|
||||
Compress: config.LumberjackConfig.Compress,
|
||||
})
|
||||
} else {
|
||||
logWriter = zapcore.AddSync(os.Stdout)
|
||||
}
|
||||
|
||||
encoder := zapcore.NewJSONEncoder(config.ZapConfig.EncoderConfig)
|
||||
level := parseLogLevel(config.ZapConfig.Level.String())
|
||||
|
||||
core := zapcore.NewCore(
|
||||
encoder,
|
||||
logWriter,
|
||||
level,
|
||||
)
|
||||
|
||||
log = zap.New(core, zap.AddCaller(), zap.AddStacktrace(zapcore.ErrorLevel))
|
||||
sugar = log.Sugar()
|
||||
}
|
||||
}
|
||||
|
||||
func GetSugaredLogger() *zap.SugaredLogger {
|
||||
load()
|
||||
return log.Sugar()
|
||||
}
|
||||
|
||||
func getEnv() string {
|
||||
env := os.Getenv("TELE_MODE")
|
||||
if env == "" {
|
||||
env = EnvDev
|
||||
}
|
||||
return env
|
||||
}
|
||||
|
||||
func getConfigFile(env string) string {
|
||||
switch env {
|
||||
case EnvTest:
|
||||
return TestConfigFileName
|
||||
case EnvProd:
|
||||
return ProdConfigFileName
|
||||
default:
|
||||
return DevelopmentConfigFileName
|
||||
}
|
||||
}
|
||||
|
||||
func loadConfig(configFile string) (LoggerConfig, error) {
|
||||
file, err := openConfigFile(configFile)
|
||||
if err != nil {
|
||||
return LoggerConfig{}, fmt.Errorf("error opening file: %v", err)
|
||||
}
|
||||
defer file.Close()
|
||||
|
||||
var config LoggerConfig
|
||||
if err := json.NewDecoder(file).Decode(&config); err != nil {
|
||||
return LoggerConfig{}, fmt.Errorf("error decoding config: %v", err)
|
||||
}
|
||||
return config, nil
|
||||
}
|
||||
|
||||
func GetLogger() *zap.SugaredLogger {
|
||||
if sugar == nil {
|
||||
load()
|
||||
}
|
||||
return sugar
|
||||
}
|
||||
|
||||
func openConfigFile(configFile string) (*os.File, error) {
|
||||
candidates := []string{
|
||||
configFile,
|
||||
filepath.Join(rootDir, strings.TrimPrefix(configFile, "./")),
|
||||
}
|
||||
for _, candidate := range candidates {
|
||||
if candidate == "" {
|
||||
continue
|
||||
}
|
||||
if f, err := os.Open(candidate); err == nil {
|
||||
return f, nil
|
||||
} else if !errors.Is(err, os.ErrNotExist) {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
return nil, fmt.Errorf("error opening file: %v", configFile)
|
||||
}
|
||||
|
||||
func parseLogLevel(level string) zapcore.Level {
|
||||
switch level {
|
||||
case "debug":
|
||||
return zapcore.DebugLevel
|
||||
case "info":
|
||||
return zapcore.InfoLevel
|
||||
case "warn":
|
||||
return zapcore.WarnLevel
|
||||
case "error":
|
||||
return zapcore.ErrorLevel
|
||||
case "dpanic":
|
||||
return zapcore.DPanicLevel
|
||||
case "panic":
|
||||
return zapcore.PanicLevel
|
||||
case "fatal":
|
||||
return zapcore.FatalLevel
|
||||
default:
|
||||
return zapcore.InfoLevel
|
||||
}
|
||||
}
|
||||
@@ -1,13 +0,0 @@
|
||||
package utils
|
||||
|
||||
import "github.com/google/uuid"
|
||||
|
||||
func GetUuid(uuidString string) uuid.UUID {
|
||||
log := GetSugaredLogger()
|
||||
result, err := uuid.Parse(uuidString)
|
||||
if err != nil {
|
||||
log.Warnf("invalid uuid: %s", uuidString)
|
||||
return uuid.New()
|
||||
}
|
||||
return result
|
||||
}
|
||||
Reference in New Issue
Block a user