説明なし
選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。

runtime_logger.go 8.1KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323
  1. // logger/runtime_logger.go
  2. package logger
  3. import (
  4. "fmt"
  5. "log"
  6. "os"
  7. "strings"
  8. "sync"
  9. "time"
  10. "git.x2erp.com/qdy/go-base/config/subconfigs"
  11. "git.x2erp.com/qdy/go-base/ctx"
  12. "git.x2erp.com/qdy/go-base/logger/http"
  13. "go.uber.org/zap"
  14. "go.uber.org/zap/zapcore"
  15. "gopkg.in/natefinch/lumberjack.v2"
  16. )
  17. var (
  18. runtimeLogger *zap.Logger
  19. runtimeSugared *zap.SugaredLogger
  20. serviceName string
  21. serviceVersion string
  22. initOnce sync.Once
  23. )
  24. // // LogContext 日志上下文
  25. // type LogContext struct {
  26. // TraceID string
  27. // UserID string
  28. // TenantID string
  29. // InstanceName string
  30. // }
  31. // InitRuntimeLogger 初始化
  32. func InitRuntimeLogger(svcName, svcVersion string, logConfig *subconfigs.LogConfig) {
  33. initOnce.Do(func() {
  34. if logConfig == nil {
  35. log.Fatal("错误: 日志配置不能为空")
  36. }
  37. serviceName = svcName
  38. serviceVersion = svcVersion
  39. // 创建logger
  40. if err := createRuntimeLogger(svcName, svcVersion, logConfig); err != nil {
  41. log.Fatal("创建运行时日志器失败: ", err)
  42. }
  43. log.Printf("[RUNTIME-LOGGER] 运行时日志系统初始化完成")
  44. log.Printf("服务名称: %s", svcName)
  45. log.Printf("日志级别: %s", logConfig.Level)
  46. })
  47. }
  48. func createRuntimeLogger(svcName, svcVersion string, cfg *subconfigs.LogConfig) error {
  49. // 1. 设置日志级别
  50. level := zap.InfoLevel
  51. switch strings.ToLower(cfg.Level) {
  52. case "debug":
  53. level = zap.DebugLevel
  54. case "warn":
  55. level = zap.WarnLevel
  56. case "error":
  57. level = zap.ErrorLevel
  58. }
  59. // 2. 编码器配置
  60. encoderConfig := zap.NewProductionEncoderConfig()
  61. encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
  62. encoderConfig.TimeKey = "timestamp"
  63. encoderConfig.MessageKey = "message"
  64. encoderConfig.LevelKey = "level"
  65. encoderConfig.CallerKey = "caller"
  66. // 3. 根据JSONFormat决定编码器
  67. var consoleEncoder, jsonEncoder zapcore.Encoder
  68. // JSON格式输出
  69. jsonEncoder = zapcore.NewJSONEncoder(encoderConfig)
  70. // 文本格式输出
  71. consoleEncoder = zapcore.NewConsoleEncoder(zapcore.EncoderConfig{
  72. TimeKey: "T",
  73. LevelKey: "L",
  74. NameKey: "N",
  75. CallerKey: "C",
  76. MessageKey: "M",
  77. StacktraceKey: "S",
  78. LineEnding: zapcore.DefaultLineEnding,
  79. EncodeLevel: zapcore.CapitalColorLevelEncoder,
  80. EncodeTime: zapcore.TimeEncoderOfLayout("2006-01-02 15:04:05"),
  81. EncodeDuration: zapcore.StringDurationEncoder,
  82. EncodeCaller: zapcore.ShortCallerEncoder,
  83. EncodeName: nil,
  84. })
  85. // 4. 输出目标
  86. cores := []zapcore.Core{}
  87. // 4.1 根据Output字段决定输出目标
  88. outputs := strings.Split(cfg.Output, ",")
  89. for _, output := range outputs {
  90. output = strings.TrimSpace(strings.ToLower(output))
  91. switch output {
  92. case "console", "stdout":
  93. // 控制台输出
  94. consoleCore := zapcore.NewCore(
  95. consoleEncoder,
  96. zapcore.AddSync(os.Stdout),
  97. level,
  98. )
  99. cores = append(cores, consoleCore)
  100. log.Printf("[RUNTIME-LOGGER] 初始化控制台日志输出(文本格式)")
  101. case "file":
  102. // 文件输出(JSON格式)
  103. if cfg.FilePath != "" {
  104. // 处理文件路径,确保有日期
  105. filePath := cfg.FilePath
  106. datedFilePath := addDateToFilePath(filePath)
  107. log.Printf("[RUNTIME-LOGGER] 创建运行时日志文件: %s", datedFilePath)
  108. fileWriter := zapcore.AddSync(&lumberjack.Logger{
  109. Filename: datedFilePath,
  110. MaxSize: cfg.MaxSize, // MB
  111. MaxBackups: cfg.MaxBackups, // 保留的文件数
  112. MaxAge: cfg.MaxAge, // 天数
  113. Compress: cfg.Compress,
  114. })
  115. fileCore := zapcore.NewCore(
  116. jsonEncoder,
  117. fileWriter,
  118. level,
  119. )
  120. cores = append(cores, fileCore)
  121. }
  122. case "es":
  123. // 1. 检查必要配置
  124. if cfg.ESPath == "" {
  125. log.Printf("[RUNTIME-LOGGER] ES地址未配置,跳过ES输出")
  126. break
  127. }
  128. // 判断是否包含console输出
  129. containsConsole := strings.Contains(strings.ToLower(cfg.Output), "console")
  130. // 2. 初始化全局ES写入器
  131. err := http.InitESWriter(
  132. svcName,
  133. cfg.ESPath,
  134. cfg.ESUsername, // 假设LogConfig已有这些字段
  135. cfg.ESPassword,
  136. containsConsole,
  137. )
  138. if err != nil {
  139. log.Printf("[RUNTIME-LOGGER] ES写入器初始化失败: %v", err)
  140. break
  141. }
  142. // 3. 创建zap core
  143. esCore := zapcore.NewCore(
  144. jsonEncoder,
  145. zapcore.AddSync(http.GetESWriter()), // 使用全局实例
  146. level,
  147. )
  148. cores = append(cores, esCore)
  149. log.Printf("[RUNTIME-LOGGER] ES日志输出已启用: %s", cfg.ESPath)
  150. }
  151. }
  152. // 5. 如果Output为空,默认输出到控制台
  153. if len(cores) == 0 {
  154. consoleCore := zapcore.NewCore(
  155. consoleEncoder,
  156. zapcore.AddSync(os.Stdout),
  157. level,
  158. )
  159. cores = append(cores, consoleCore)
  160. }
  161. // 6. 创建组合core
  162. core := zapcore.NewTee(cores...)
  163. // 7. 创建logger
  164. runtimeLogger = zap.New(core,
  165. zap.AddCaller(),
  166. zap.AddCallerSkip(2),
  167. zap.AddStacktrace(zap.ErrorLevel),
  168. //zap.Fields(
  169. // zap.String("service", svcName),
  170. // zap.String("version", serviceVersion),
  171. //),
  172. )
  173. runtimeSugared = runtimeLogger.Sugar()
  174. return nil
  175. }
  176. // addDateToFilePath 在文件路径中添加日期
  177. func addDateToFilePath(filePath string) string {
  178. // 如果已经包含 %s,则替换为日期
  179. if strings.Contains(filePath, "%s") {
  180. return strings.ReplaceAll(filePath, "%s", time.Now().Format("20060102"))
  181. }
  182. // 如果没有 %s,在扩展名前添加日期
  183. extIndex := strings.LastIndex(filePath, ".")
  184. if extIndex > 0 {
  185. return filePath[:extIndex] + "-" + time.Now().Format("20060102") + filePath[extIndex:]
  186. }
  187. // 没有扩展名,直接在末尾添加日期
  188. return filePath + "-" + time.Now().Format("20060102")
  189. }
  190. // WithC 创建带有上下文的logger(C代表Context)
  191. func W(ctx *ctx.RequestContext) *zap.SugaredLogger {
  192. // 直接使用,不会为空
  193. return runtimeLogger.With(
  194. zap.String("service", serviceName),
  195. zap.String("version", serviceVersion),
  196. zap.String("trace_id", ctx.TraceID),
  197. zap.String("user_id", ctx.UserID),
  198. zap.String("tenant_id", ctx.TenantID),
  199. zap.String("instance_name", ctx.InstanceName),
  200. ).Sugar()
  201. }
  202. // ============ 上下文日志快捷方法 ============
  203. // InfoC 带上下文的Info日志
  204. func InfoC(ctx *ctx.RequestContext, format string, args ...interface{}) {
  205. W(ctx).Infof(format, args...)
  206. }
  207. // ErrorC 带上下文的Error日志
  208. func ErrorC(ctx *ctx.RequestContext, format string, args ...interface{}) {
  209. W(ctx).Errorf(format, args...)
  210. }
  211. // DebugC 带上下文的Debug日志
  212. func DebugC(ctx *ctx.RequestContext, format string, args ...interface{}) {
  213. W(ctx).Debugf(format, args...)
  214. }
  215. // WarnC 带上下文的Warn日志
  216. func WarnC(ctx *ctx.RequestContext, format string, args ...interface{}) {
  217. W(ctx).Warnf(format, args...)
  218. }
  219. // FatalC 带上下文的Fatal日志
  220. func FatalC(ctx *ctx.RequestContext, format string, args ...interface{}) {
  221. W(ctx).Fatalf(format, args...)
  222. }
  223. // ============ 原始日志方法 ============
  224. // Info 普通Info日志
  225. func Info(format string, args ...interface{}) {
  226. runtimeSugared.Infof(format, args...)
  227. }
  228. // Error 普通Error日志
  229. func Error(format string, args ...interface{}) {
  230. runtimeSugared.Errorf(format, args...)
  231. }
  232. // Debug 普通Debug日志
  233. func Debug(format string, args ...interface{}) {
  234. runtimeSugared.Debugf(format, args...)
  235. }
  236. // Warn 普通Warn日志
  237. func Warn(format string, args ...interface{}) {
  238. runtimeSugared.Warnf(format, args...)
  239. }
  240. // Fatal 普通Fatal日志
  241. func Fatal(format string, args ...interface{}) {
  242. runtimeSugared.Fatalf(format, args...)
  243. }
  244. // Errorf 记录错误日志并返回格式化错误
  245. func Errorf(format string, args ...interface{}) error {
  246. err := fmt.Errorf(format, args...)
  247. runtimeSugared.Errorf(format, args...)
  248. return err
  249. }
  250. // ErrorCf 带上下文的错误日志并返回格式化错误
  251. func ErrorCf(ctx *ctx.RequestContext, format string, args ...interface{}) error {
  252. err := fmt.Errorf(format, args...)
  253. ErrorC(ctx, format, args...)
  254. return err
  255. }
  256. // ============ 其他方法 ============
  257. // GetZapLogger 获取原始zap.Logger
  258. func GetZapLogger() *zap.Logger {
  259. return runtimeLogger
  260. }
  261. // Sync 同步日志
  262. func Sync() error {
  263. if runtimeLogger != nil {
  264. return runtimeLogger.Sync()
  265. }
  266. return nil
  267. }
  268. // StopESWriter 停止ES写入器
  269. func StopESWriter() {
  270. http.StopESWriter()
  271. }