Brak opisu
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 9.1KB

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