logger/define.go

// Package logger ...
//
// Description : logger ...
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 2022-06-12 18:39
package logger

import (
	"strings"
	"time"

	"git.zhangdeman.cn/zhangdeman/consts"

	"git.zhangdeman.cn/zhangdeman/websocket/storage"
	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
)

// FillLogDataFunc 定义填充数据的方法
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 21:33 2024/7/24
type FillLogDataFunc func(data *LogData)

var (
	wsLoggerConnect storage.IConnection // ws 日志连接管理实例
	fillLogDataFunc FillLogDataFunc     // 填充数据方法
)

// SetWsLoggConnect 设置ws connect
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 15:20 2024/7/23
func SetWsLoggConnect(connect storage.IConnection) {
	wsLoggerConnect = connect
}

// GetWsLoggConnect 获取ws连接
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 15:34 2024/7/23
func GetWsLoggConnect(connect storage.IConnection) {
	wsLoggerConnect = connect
}

// SetFillLogDataFunc ...
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 21:34 2024/7/24
func SetFillLogDataFunc(fillFunc FillLogDataFunc) {
	fillLogDataFunc = fillFunc
}

// GetFillLogDataFunc 获取填充数据的方法
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 21:36 2024/7/24
func GetFillLogDataFunc() FillLogDataFunc {
	if nil == fillLogDataFunc {
		return func(data *LogData) {

		}
	}
	return fillLogDataFunc
}

// LogData 记录日志数据
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 16:07 2024/7/23
type LogData struct {
	Env            string         `json:"env"`             // 运行环境
	Uri            string         `json:"uri"`             // 请求的接口
	TraceID        string         `json:"trace_id"`        // 请求的trace_id
	UserID         string         `json:"user_id"`         // 用户ID
	UserRoleID     string         `json:"user_role_id"`    // 用户角色
	OperateMode    string         `json:"operate_mode"`    // 操作模式
	LogType        string         `json:"log_type"`        // 日志类型
	CodeVersion    string         `json:"code_version"`    // 代码版本
	ServiceVersion string         `json:"service_version"` // 服务本身的版本
	ClientIp       string         `json:"client_ip"`       // 客户端IP
	ServerIp       string         `json:"server_ip"`       // 服务器IP
	Hostname       string         `json:"hostname"`        // 服务器主机名
	Code           string         `json:"code"`            // 日志状态码
	Data           map[string]any `json:"data"`            // 扩展记录的数据, 会展开一层进行记录
}

// InputLogConfig 输入的日志配置
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 18:40 2022/6/12
type InputLogConfig struct {
	Name             string `json:"name" yaml:"name"`                             // 日志文件名
	Path             string `json:"path" yaml:"path"`                             // 日志文件路径
	TimeIntervalType string `json:"time_interval_type" yaml:"time_interval_type"` // 日志切割规则
	DivisionChar     string `json:"division_char" yaml:"division_char"`           // 文件名分隔符
	LogLevel         string `json:"log_level" yaml:"log_level"`                   // 日志等级
	Console          bool   `json:"console" yaml:"console"`                       // 是否进行控制台日志输出
	UseJson          bool   `json:"use_json" yaml:"use_json"`                     // 日志是否使用JSON格式
	FileLine         bool   `json:"file_line" yaml:"file_line"`                   // 日志是否打印行号
	MessageKey       string `json:"message_key" yaml:"message_key"`               // message 字段
	LevelKey         string `json:"level_key" yaml:"level_key"`                   // level 字段
	TimeKey          string `json:"time_key" yaml:"time_key"`                     // 时间字段
	CallerKey        string `json:"caller_key" yaml:"caller_key"`                 // 记录日志的文件的代码行数
	UseShortFile     bool   `json:"use_short_file" yaml:"use_short_file"`         // 是否使用短文件格式
	CallerSkip       int    `json:"caller_skip" yaml:"caller_skip"`               // 日志记录的文件跳过多少层
	MaxAge           int    `json:"max_age" yaml:"max_age"`                       // 日志最长保存时间, 单位 : 秒
}

// GetLogInstanceFromInputConfig 从输入配置获取日志实例
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 18:43 2022/6/12
func GetLogInstanceFromInputConfig(logConf *InputLogConfig) (*zap.Logger, error) {
	if nil == logConf {
		return nil, nil
	}
	logConfList := []SetLoggerOptionFunc{
		WithCallerSkip(logConf.CallerSkip),
		WithCaller(),
		WithUseJsonFormat(logConf.UseJson),
		WithShortCaller(logConf.UseShortFile),
	}
	if logConf.Console {
		logConfList = append(logConfList, WithConsoleOutput())
	}

	var (
		err            error
		loggerInstance *zap.Logger
		splitConfig    *RotateLogConfig
	)
	if splitConfig, err = NewRotateLogConfig(
		logConf.Path,
		logConf.Name,
		WithDivisionChar(logConf.DivisionChar),
		WithTimeIntervalType(logConf.TimeIntervalType),
		WithMaxAge(time.Duration(logConf.MaxAge)*time.Second)); nil != err {
		return nil, err
	}
	if loggerInstance, err = NewLogger(logConf.LogLevel, splitConfig, logConfList...); nil != err {
		return nil, err
	}
	return loggerInstance, nil
}

// inputLevel2ZapLevel 输入日志等级转化为zap日志等级
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 18:07 2024/6/24
func inputLevel2ZapLevel(inputLoggerLevel string) zapcore.Level {
	loggerLevel := zapcore.DebugLevel
	switch strings.ToUpper(inputLoggerLevel) {
	case consts.LogLevelDebug:
		loggerLevel = zapcore.DebugLevel
	case consts.LogLevelInfo:
		loggerLevel = zapcore.InfoLevel
	case consts.LogLevelWarn:
		loggerLevel = zapcore.WarnLevel
	case consts.LogLevelError:
		loggerLevel = zapcore.ErrorLevel
	case consts.LogLevelPanic:
		loggerLevel = zapcore.PanicLevel
	}
	return loggerLevel
}