event.go 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177
  1. package log
  2. import (
  3. "encoding/json"
  4. "fmt"
  5. "log"
  6. "os"
  7. "sort"
  8. "strings"
  9. "time"
  10. )
  11. const (
  12. tagField = "tag"
  13. errorField = "error"
  14. )
  15. // Event represents a single log event
  16. type Event struct {
  17. Timestamp int64 `json:"time"`
  18. Level Level `json:"level"`
  19. Message string `json:"message"`
  20. fields Context
  21. }
  22. // newEvent creates a new log event
  23. func newEvent() *Event {
  24. return &Event{
  25. Timestamp: time.Now().UnixMilli(),
  26. fields: make(Context),
  27. }
  28. }
  29. // Fatal logs the event as FATAL, and exits the program with exit code 1
  30. func (e *Event) Fatal(message string, v ...any) {
  31. e.Field("exit_code", 1).Log(FatalLevel, message, v...)
  32. fmt.Fprintf(os.Stderr, message+"\n", v...) // Always output error to stderr
  33. os.Exit(1)
  34. }
  35. // Error logs the event with log level error
  36. func (e *Event) Error(message string, v ...any) {
  37. e.Log(ErrorLevel, message, v...)
  38. }
  39. // Warn logs the event with log level warn
  40. func (e *Event) Warn(message string, v ...any) {
  41. e.Log(WarnLevel, message, v...)
  42. }
  43. // Info logs the event with log level info
  44. func (e *Event) Info(message string, v ...any) {
  45. e.Log(InfoLevel, message, v...)
  46. }
  47. // Debug logs the event with log level debug
  48. func (e *Event) Debug(message string, v ...any) {
  49. e.Log(DebugLevel, message, v...)
  50. }
  51. // Trace logs the event with log level trace
  52. func (e *Event) Trace(message string, v ...any) {
  53. e.Log(TraceLevel, message, v...)
  54. }
  55. // Tag adds a "tag" field to the log event
  56. func (e *Event) Tag(tag string) *Event {
  57. e.fields[tagField] = tag
  58. return e
  59. }
  60. // Time sets the time field
  61. func (e *Event) Time(time time.Time) *Event {
  62. e.Timestamp = time.UnixMilli()
  63. return e
  64. }
  65. // Err adds an "error" field to the log event
  66. func (e *Event) Err(err error) *Event {
  67. if c, ok := err.(Contexter); ok {
  68. e.Fields(c.Context())
  69. } else {
  70. e.fields[errorField] = err.Error()
  71. }
  72. return e
  73. }
  74. // Field adds a custom field and value to the log event
  75. func (e *Event) Field(key string, value any) *Event {
  76. e.fields[key] = value
  77. return e
  78. }
  79. // Fields adds a map of fields to the log event
  80. func (e *Event) Fields(fields Context) *Event {
  81. for k, v := range fields {
  82. e.fields[k] = v
  83. }
  84. return e
  85. }
  86. // With adds the fields of the given Contexter structs to the log event by calling their With method
  87. func (e *Event) With(contexts ...Contexter) *Event {
  88. for _, c := range contexts {
  89. e.Fields(c.Context())
  90. }
  91. return e
  92. }
  93. // Log logs a message with the given log level
  94. func (e *Event) Log(l Level, message string, v ...any) {
  95. e.Message = fmt.Sprintf(message, v...)
  96. e.Level = l
  97. if e.shouldPrint() {
  98. if CurrentFormat() == JSONFormat {
  99. log.Println(e.JSON())
  100. } else {
  101. log.Println(e.String())
  102. }
  103. }
  104. }
  105. // Loggable returns true if the given log level is lower or equal to the current log level
  106. func (e *Event) Loggable(l Level) bool {
  107. return e.globalLevelWithOverride() <= l
  108. }
  109. // IsTrace returns true if the current log level is TraceLevel
  110. func (e *Event) IsTrace() bool {
  111. return e.Loggable(TraceLevel)
  112. }
  113. // IsDebug returns true if the current log level is DebugLevel or below
  114. func (e *Event) IsDebug() bool {
  115. return e.Loggable(DebugLevel)
  116. }
  117. // JSON returns the event as a JSON representation
  118. func (e *Event) JSON() string {
  119. b, _ := json.Marshal(e)
  120. s := string(b)
  121. if len(e.fields) > 0 {
  122. b, _ := json.Marshal(e.fields)
  123. s = fmt.Sprintf("{%s,%s}", s[1:len(s)-1], string(b[1:len(b)-1]))
  124. }
  125. return s
  126. }
  127. // String returns the event as a string
  128. func (e *Event) String() string {
  129. if len(e.fields) == 0 {
  130. return fmt.Sprintf("%s %s", e.Level.String(), e.Message)
  131. }
  132. fields := make([]string, 0)
  133. for k, v := range e.fields {
  134. fields = append(fields, fmt.Sprintf("%s=%v", k, v))
  135. }
  136. sort.Strings(fields)
  137. return fmt.Sprintf("%s %s (%s)", e.Level.String(), e.Message, strings.Join(fields, ", "))
  138. }
  139. func (e *Event) shouldPrint() bool {
  140. return e.globalLevelWithOverride() <= e.Level
  141. }
  142. func (e *Event) globalLevelWithOverride() Level {
  143. mu.Lock()
  144. l, ov := level, overrides
  145. mu.Unlock()
  146. for field, override := range ov {
  147. value, exists := e.fields[field]
  148. if exists && value == override.value {
  149. return override.level
  150. }
  151. }
  152. return l
  153. }