richlogger.go 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
  1. package logx
  2. import (
  3. "context"
  4. "fmt"
  5. "time"
  6. "github.com/zeromicro/go-zero/core/timex"
  7. "github.com/zeromicro/go-zero/internal/trace"
  8. )
  9. // WithCallerSkip returns a Logger with given caller skip.
  10. func WithCallerSkip(skip int) Logger {
  11. if skip <= 0 {
  12. return new(richLogger)
  13. }
  14. return &richLogger{
  15. callerSkip: skip,
  16. }
  17. }
  18. // WithContext sets ctx to log, for keeping tracing information.
  19. func WithContext(ctx context.Context) Logger {
  20. return &richLogger{
  21. ctx: ctx,
  22. }
  23. }
  24. // WithDuration returns a Logger with given duration.
  25. func WithDuration(d time.Duration) Logger {
  26. return &richLogger{
  27. fields: []LogField{Field(durationKey, timex.ReprOfDuration(d))},
  28. }
  29. }
  30. type richLogger struct {
  31. ctx context.Context
  32. callerSkip int
  33. fields []LogField
  34. }
  35. func (l *richLogger) Debug(v ...any) {
  36. l.debug(fmt.Sprint(v...))
  37. }
  38. func (l *richLogger) Debugf(format string, v ...any) {
  39. l.debug(fmt.Sprintf(format, v...))
  40. }
  41. func (l *richLogger) Debugv(v any) {
  42. l.debug(v)
  43. }
  44. func (l *richLogger) Debugw(msg string, fields ...LogField) {
  45. l.debug(msg, fields...)
  46. }
  47. func (l *richLogger) Error(v ...any) {
  48. l.err(fmt.Sprint(v...))
  49. }
  50. func (l *richLogger) Errorf(format string, v ...any) {
  51. l.err(fmt.Sprintf(format, v...))
  52. }
  53. func (l *richLogger) Errorv(v any) {
  54. l.err(v)
  55. }
  56. func (l *richLogger) Errorw(msg string, fields ...LogField) {
  57. l.err(msg, fields...)
  58. }
  59. func (l *richLogger) Info(v ...any) {
  60. l.info(fmt.Sprint(v...))
  61. }
  62. func (l *richLogger) Infof(format string, v ...any) {
  63. l.info(fmt.Sprintf(format, v...))
  64. }
  65. func (l *richLogger) Infov(v any) {
  66. l.info(v)
  67. }
  68. func (l *richLogger) Infow(msg string, fields ...LogField) {
  69. l.info(msg, fields...)
  70. }
  71. func (l *richLogger) Slow(v ...any) {
  72. l.slow(fmt.Sprint(v...))
  73. }
  74. func (l *richLogger) Slowf(format string, v ...any) {
  75. l.slow(fmt.Sprintf(format, v...))
  76. }
  77. func (l *richLogger) Slowv(v any) {
  78. l.slow(v)
  79. }
  80. func (l *richLogger) Sloww(msg string, fields ...LogField) {
  81. l.slow(msg, fields...)
  82. }
  83. func (l *richLogger) WithCallerSkip(skip int) Logger {
  84. if skip <= 0 {
  85. return l
  86. }
  87. l.callerSkip = skip
  88. return l
  89. }
  90. func (l *richLogger) WithContext(ctx context.Context) Logger {
  91. l.ctx = ctx
  92. return l
  93. }
  94. func (l *richLogger) WithDuration(duration time.Duration) Logger {
  95. l.fields = append(l.fields, Field(durationKey, timex.ReprOfDuration(duration)))
  96. return l
  97. }
  98. func (l *richLogger) WithFields(fields ...LogField) Logger {
  99. l.fields = append(l.fields, fields...)
  100. return l
  101. }
  102. func (l *richLogger) buildFields(fields ...LogField) []LogField {
  103. fields = append(l.fields, fields...)
  104. fields = append(fields, Field(callerKey, getCaller(callerDepth+l.callerSkip)))
  105. if l.ctx == nil {
  106. return fields
  107. }
  108. traceID := trace.TraceIDFromContext(l.ctx)
  109. if len(traceID) > 0 {
  110. fields = append(fields, Field(traceKey, traceID))
  111. }
  112. spanID := trace.SpanIDFromContext(l.ctx)
  113. if len(spanID) > 0 {
  114. fields = append(fields, Field(spanKey, spanID))
  115. }
  116. val := l.ctx.Value(fieldsContextKey)
  117. if val != nil {
  118. if arr, ok := val.([]LogField); ok {
  119. fields = append(fields, arr...)
  120. }
  121. }
  122. return fields
  123. }
  124. func (l *richLogger) debug(v any, fields ...LogField) {
  125. if shallLog(DebugLevel) {
  126. getWriter().Debug(v, l.buildFields(fields...)...)
  127. }
  128. }
  129. func (l *richLogger) err(v any, fields ...LogField) {
  130. if shallLog(ErrorLevel) {
  131. getWriter().Error(v, l.buildFields(fields...)...)
  132. }
  133. }
  134. func (l *richLogger) info(v any, fields ...LogField) {
  135. if shallLog(InfoLevel) {
  136. getWriter().Info(v, l.buildFields(fields...)...)
  137. }
  138. }
  139. func (l *richLogger) slow(v any, fields ...LogField) {
  140. if shallLog(ErrorLevel) {
  141. getWriter().Slow(v, l.buildFields(fields...)...)
  142. }
  143. }