暫無描述
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

runtime_logger.go 7.4KB

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