Skip to content

Improve TimedLog #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 14, 2025
Merged

Improve TimedLog #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c3f5eec
additional skip on TimedLog
TomK Apr 14, 2025
f9d8459
don't use zapper directly (we lose common)
TomK Apr 14, 2025
213e3f2
support passing additional fields on completion of TimedLog
TomK Apr 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,14 @@ module github.com/packaged/logger/v3
go 1.20

require (
github.com/packaged/environment v1.0.0
github.com/stretchr/testify v1.8.1
go.uber.org/zap v1.24.0
github.com/packaged/environment v1.1.0
github.com/stretchr/testify v1.10.0
go.uber.org/zap v1.27.0
)

require (
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
go.uber.org/atomic v1.11.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)
25 changes: 7 additions & 18 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,17 @@
github.com/benbjohnson/clock v1.1.0 h1:Q92kusRqC1XV2MjkWETPvjJVqKetz1OzxZB7mHJLju8=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/packaged/environment v1.0.0 h1:cJp5QiFW84uys0a5DGtnxu5DFhrB4lpfK3zw1GhZCG8=
github.com/packaged/environment v1.0.0/go.mod h1:P3je+kjXqJuu6vhQeDMqCqaB9biE6ITXswSA3Dts7Oc=
github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
github.com/packaged/environment v1.1.0 h1:TxABnUoqPzzg8c1WeVfux3cmUOyd0HggvRrvIlmfxIM=
github.com/packaged/environment v1.1.0/go.mod h1:P3je+kjXqJuu6vhQeDMqCqaB9biE6ITXswSA3Dts7Oc=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
go.uber.org/atomic v1.11.0 h1:ZvwS0R+56ePWxUNi+Atn9dWONBPp/AUETXlHW0DxSjE=
go.uber.org/atomic v1.11.0/go.mod h1:LUxbIzbOniOlMKjJjyPfpl4v+PKK2cNJn91OQbhoJI0=
go.uber.org/goleak v1.1.11 h1:wy28qYRKZgnJTxGxvye5/wgWr1EKjmUDGYox5mGlRlI=
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0=
go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
go.uber.org/zap v1.24.0 h1:FiJd5l1UOLj0wCgbSE0rwwXHzEdAZS6hiiSnxJN/D60=
go.uber.org/zap v1.24.0/go.mod h1:2kMP+WWQ8aoFoedH3T2sq6iJ2yDWpHbP0f6MQbS9Gkg=
go.uber.org/zap v1.27.0 h1:aJMhYGrd5QSmlpLMr2MftRKl7t8J8PTZPA732ud/XR8=
go.uber.org/zap v1.27.0/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
21 changes: 15 additions & 6 deletions logger/timed.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,27 @@
package logger

import (
"go.uber.org/zap"
"time"

"go.uber.org/zap"
)

type TimedLogConfig struct {

Check failure on line 9 in logger/timed.go

View workflow job for this annotation

GitHub Actions / code-checks 

exported type TimedLogConfig should have comment or be unexported
ErrorDuration time.Duration
WarnDuration time.Duration
InfoDuration time.Duration
DebugDuration time.Duration
}

Check warning on line 14 in logger/timed.go

View workflow job for this annotation

GitHub Actions / code-checks 

exported type TimedLogConfig should have comment or be unexported

func DefaultTimedLogConfig() *TimedLogConfig {

Check failure on line 16 in logger/timed.go

View workflow job for this annotation

GitHub Actions / code-checks 

exported function DefaultTimedLogConfig should have comment or be unexported
return defaultTimedLogConfig
}

Check warning on line 18 in logger/timed.go

View workflow job for this annotation

GitHub Actions / code-checks 

exported function DefaultTimedLogConfig should have comment or be unexported

func (c *TimedLogConfig) NewLog(message string, fields ...zap.Field) *TimedLog {

Check failure on line 20 in logger/timed.go

View workflow job for this annotation

GitHub Actions / code-checks 

exported method TimedLogConfig.NewLog should have comment or be unexported
return NewTimedLog(c, message, fields...)
}

Check warning on line 22 in logger/timed.go

View workflow job for this annotation

GitHub Actions / code-checks 

exported method TimedLogConfig.NewLog should have comment or be unexported

type TimedLog struct {

Check failure on line 24 in logger/timed.go

View workflow job for this annotation

GitHub Actions / code-checks 

exported type TimedLog should have comment or be unexported
config *TimedLogConfig
message string
fields []zap.Field
Expand All @@ -29,7 +30,7 @@
complete bool
}

Check warning on line 31 in logger/timed.go

View workflow job for this annotation

GitHub Actions / code-checks 

exported type TimedLog should have comment or be unexported

func (tl *TimedLog) Complete() {

Check failure on line 33 in logger/timed.go

View workflow job for this annotation

GitHub Actions / code-checks 

exported method TimedLog.Complete should have comment or be unexported
if !tl.complete {
tl.duration = time.Since(tl.start)
tl.complete = true
Expand All @@ -43,24 +44,32 @@
DebugDuration: 500 * time.Millisecond,
}

func NewTimedLog(cnf *TimedLogConfig, message string, fields ...zap.Field) *TimedLog {

Check failure on line 47 in logger/timed.go

View workflow job for this annotation

GitHub Actions / code-checks 

exported function NewTimedLog should have comment or be unexported
return &TimedLog{config: cnf, message: message, fields: fields, start: time.Now()}
}

Check warning on line 49 in logger/timed.go

View workflow job for this annotation

GitHub Actions / code-checks 

exported function NewTimedLog should have comment or be unexported

func (l *Logger) TimedLog(tl *TimedLog) {
func (l *Logger) TimedLog(tl *TimedLog, fields ...zap.Field) {

Check failure on line 51 in logger/timed.go

View workflow job for this annotation

GitHub Actions / code-checks 

exported method Logger.TimedLog should have comment or be unexported
if l == nil || tl == nil {
return
}

tl.Complete()

nl := l.Clone()
nl.zapper = nl.zapper.WithOptions(zap.AddCallerSkip(1))

logFields := tl.fields
logFields = append(logFields, tl.fields...)
logFields = append(logFields, fields...)
logFields = append(logFields, zap.Duration("duration", tl.duration))

if tl.duration >= tl.config.ErrorDuration && tl.config.ErrorDuration > 0 {
l.Error(tl.message, append(tl.fields, zap.Duration("duration", tl.duration))...)
nl.Error(tl.message, logFields...)
} else if tl.duration >= tl.config.WarnDuration && tl.config.WarnDuration > 0 {
l.Warn(tl.message, append(tl.fields, zap.Duration("duration", tl.duration))...)
nl.Warn(tl.message, logFields...)
} else if tl.duration >= tl.config.InfoDuration && tl.config.InfoDuration > 0 {
l.Info(tl.message, append(tl.fields, zap.Duration("duration", tl.duration))...)
nl.Info(tl.message, logFields...)
} else if tl.duration >= tl.config.DebugDuration && tl.config.DebugDuration > 0 {
l.Debug(tl.message, append(tl.fields, zap.Duration("duration", tl.duration))...)
nl.Debug(tl.message, logFields...)
}
}

Check warning on line 75 in logger/timed.go

View workflow job for this annotation

GitHub Actions / code-checks 

exported method Logger.TimedLog should have comment or be unexported