Add Zerolog formatter #50

zzzLobster · 2025-03-03T20:25:15Z

Add Zerolog formatter

Log entry looks like this:

{
  "level": "error",
  "stack": "Oops: permission denied\n  --- at ... main()",
  "error": {
    "code": "iam_authz_missing_permission",
    "domain": "authz",
    "context": {
      "hello": "world",
      "user_id": 1234,
      "permission": "post.create"
    },
    "user": {
      "firstname": "john",
      "id": "user-123",
      "lastname": "doe"
    },
    "error": "something failed: permission denied",
    "trace": "6710668a-2b2a-4de6-b8cf-3272a476a1c9",
    "hint": "Runbook: https://doc.acme.org/doc/abcd.md",
    "time": "2025-03-03T19:53:26.338249Z"
  },
  "time": "2025-03-03T22:53:26+03:00",
  "message": "something failed: permission denied"
}

zzzLobster · 2025-03-03T20:25:41Z

@samber , Should I raise an issue before submitting a PR?

samber

Please add it to readme as well. ✌️

(ctrl-f logrus)

samber · 2025-03-04T13:41:47Z

Makefile

+	go -C loggers/zerolog test -race -v ./...
 watch-test:
-	reflex -t 50ms -s -- sh -c 'gotest -race -v ./...'
+	reflex -t 50ms -s -- sh -c 'gotest -race -v ./... && go -C loggers/zerolog test -race -v ./...'


i'm pretty sure it is not necessary, since you declared this submodule in go.work

Unfortunately, there is no a straight way to do that right now.
There is a proposal for that: golang/go#71294 (accepted, but it's not a part of cmd/go so far)

go test -race -v ./... === RUN TestErrorsIs --- PASS: TestErrorsIs (0.00s) === RUN TestErrorsAs --- PASS: TestErrorsAs (0.00s) === RUN TestDereferencePointers --- PASS: TestDereferencePointers (0.00s) === RUN TestOopsWrap --- PASS: TestOopsWrap (0.00s) === RUN TestOopsWrap_wrapped --- PASS: TestOopsWrap_wrapped (0.10s) === RUN TestOopsWrapf --- PASS: TestOopsWrapf (0.00s) === RUN TestOopsFromContext --- PASS: TestOopsFromContext (0.00s) === RUN TestOopsNew --- PASS: TestOopsNew (0.00s) === RUN TestOopsErrorf --- PASS: TestOopsErrorf (0.00s) === RUN TestOopsCode --- PASS: TestOopsCode (0.00s) === RUN TestOopsTime --- PASS: TestOopsTime (0.00s) === RUN TestOopsSince --- PASS: TestOopsSince (0.01s) === RUN TestOopsDuration --- PASS: TestOopsDuration (0.01s) === RUN TestOopsIn --- PASS: TestOopsIn (0.00s) === RUN TestOopsTags --- PASS: TestOopsTags (0.00s) === RUN TestOopsTx --- PASS: TestOopsTx (0.00s) === RUN TestOopsTxSpanFromOtel --- PASS: TestOopsTxSpanFromOtel (0.00s) === RUN TestOopsWith --- PASS: TestOopsWith (0.00s) === RUN TestOopsWithContext --- PASS: TestOopsWithContext (0.00s) === RUN TestOopsWithLazyEvaluation --- PASS: TestOopsWithLazyEvaluation (0.00s) === RUN TestOopsHint --- PASS: TestOopsHint (0.00s) === RUN TestOopsPublic --- PASS: TestOopsPublic (0.00s) === RUN TestOopsOwner --- PASS: TestOopsOwner (0.00s) === RUN TestOopsUser --- PASS: TestOopsUser (0.00s) === RUN TestOopsTenant --- PASS: TestOopsTenant (0.00s) === RUN TestOopsRequest --- PASS: TestOopsRequest (0.00s) === RUN TestOopsMixed --- PASS: TestOopsMixed (0.00s) === RUN TestOopsMixedWithGetters --- PASS: TestOopsMixedWithGetters (0.00s) === RUN TestOopsLogValuer --- PASS: TestOopsLogValuer (0.00s) === RUN TestOopsFormatSummary --- PASS: TestOopsFormatSummary (0.00s) === RUN TestOopsFormatVerbose --- PASS: TestOopsFormatVerbose (0.00s) === RUN TestOopsMarshalJSON --- PASS: TestOopsMarshalJSON (0.00s) === RUN TestOopsGetPublic --- PASS: TestOopsGetPublic (0.00s) === RUN TestRemoveGoPath --- PASS: TestRemoveGoPath (0.00s) === RUN TestStacktrace --- PASS: TestStacktrace (0.00s) PASS ok github.com/samber/oops (cached)

(it does not run the new test)

go -C loggers/zerolog test -race -v ./... === RUN TestZerologFormatter --- PASS: TestZerologFormatter (0.00s) PASS ok github.com/samber/oops/loggers/zerolog (cached)

Possible one-liner (I'm not sure if that's gonna work in CI):

go list -f '{{.Dir}}' -m | xargs go test -race -v ? github.com/samber/oops/examples/log [no test files] ? github.com/samber/oops/examples/panic [no test files] ? github.com/samber/oops/examples/logrus [no test files] ? github.com/samber/oops/examples/segfault [no test files] ? github.com/samber/oops/examples/slog [no test files] ? github.com/samber/oops/examples/sources [no test files] ? github.com/samber/oops/examples/zerolog [no test files] === RUN TestErrorsIs --- PASS: TestErrorsIs (0.00s) === RUN TestErrorsAs --- PASS: TestErrorsAs (0.00s) === RUN TestDereferencePointers --- PASS: TestDereferencePointers (0.00s) === RUN TestOopsWrap --- PASS: TestOopsWrap (0.00s) === RUN TestOopsWrap_wrapped --- PASS: TestOopsWrap_wrapped (0.10s) === RUN TestOopsWrapf --- PASS: TestOopsWrapf (0.00s) === RUN TestOopsFromContext --- PASS: TestOopsFromContext (0.00s) === RUN TestOopsNew --- PASS: TestOopsNew (0.00s) === RUN TestOopsErrorf --- PASS: TestOopsErrorf (0.00s) === RUN TestOopsCode --- PASS: TestOopsCode (0.00s) === RUN TestOopsTime --- PASS: TestOopsTime (0.00s) === RUN TestOopsSince --- PASS: TestOopsSince (0.01s) === RUN TestOopsDuration --- PASS: TestOopsDuration (0.01s) === RUN TestOopsIn --- PASS: TestOopsIn (0.00s) === RUN TestOopsTags --- PASS: TestOopsTags (0.00s) === RUN TestOopsTx --- PASS: TestOopsTx (0.00s) === RUN TestOopsTxSpanFromOtel --- PASS: TestOopsTxSpanFromOtel (0.00s) === RUN TestOopsWith --- PASS: TestOopsWith (0.00s) === RUN TestOopsWithContext --- PASS: TestOopsWithContext (0.00s) === RUN TestOopsWithLazyEvaluation --- PASS: TestOopsWithLazyEvaluation (0.00s) === RUN TestOopsHint --- PASS: TestOopsHint (0.00s) === RUN TestOopsPublic --- PASS: TestOopsPublic (0.00s) === RUN TestOopsOwner --- PASS: TestOopsOwner (0.00s) === RUN TestOopsUser --- PASS: TestOopsUser (0.00s) === RUN TestOopsTenant --- PASS: TestOopsTenant (0.00s) === RUN TestOopsRequest --- PASS: TestOopsRequest (0.00s) === RUN TestOopsMixed --- PASS: TestOopsMixed (0.00s) === RUN TestOopsMixedWithGetters --- PASS: TestOopsMixedWithGetters (0.00s) === RUN TestOopsLogValuer --- PASS: TestOopsLogValuer (0.00s) === RUN TestOopsFormatSummary --- PASS: TestOopsFormatSummary (0.00s) === RUN TestOopsFormatVerbose --- PASS: TestOopsFormatVerbose (0.00s) === RUN TestOopsMarshalJSON --- PASS: TestOopsMarshalJSON (0.00s) === RUN TestOopsGetPublic --- PASS: TestOopsGetPublic (0.00s) === RUN TestRemoveGoPath --- PASS: TestRemoveGoPath (0.00s) === RUN TestStacktrace --- PASS: TestStacktrace (0.00s) PASS ok github.com/samber/oops (cached) testing: warning: no tests to run PASS ok github.com/samber/oops/loggers/logrus (cached) [no tests to run] === RUN TestZerologFormatter --- PASS: TestZerologFormatter (0.00s) PASS ok github.com/samber/oops/loggers/zerolog (cached) ? github.com/samber/oops/recovery/gin [no test files]

Oh yes, sorry. I did this in another project:

MODULES=$(shell go list -m) test: go test -race -v ${MODULES} ./...

feel free to change the readme and add logrus submodule

the limit of both methods is that go.work version must be compatible with submodule

I'm not sure I precisely understand what you mean.
What readme do you mean in this case?

I propose to use your approach from that another project:

MODULES=$(shell go list -m) build: go build -v ./... test: go test -race -v ${MODULES} ./... watch-test: reflex -t 50ms -s -- sh -c 'gotest -race -v ${MODULES} ./...'

and update other goals same way

sorry, I mean the Makefile :-(

Please take a look at the latest commit with the changes in Makefile.
Same issue is applicable to golangci-lint, the difference is that it wants directories, not packages (updated it as well and it forced me to fix a couple of files)

zzzLobster · 2025-03-04T14:11:44Z

Please add it to readme as well. ✌️

(ctrl-f logrus)

I've updated the root README. I hope I've not missed anything

examples/zerolog/go.mod

loggers/zerolog/go.mod

samber · 2025-03-04T19:38:05Z

Thanks!

Let's merge ;)

[edit] i'm going to make a release as soon as the other pr is done

Zerolog formatter

f905622

zzzLobster force-pushed the feat/zerolog branch from defbd07 to f905622 Compare March 3, 2025 20:29

samber requested changes Mar 4, 2025

View reviewed changes

README

ac9b8f5

samber requested changes Mar 4, 2025

View reviewed changes

examples/zerolog/go.mod Outdated Show resolved Hide resolved

loggers/zerolog/go.mod Outdated Show resolved Hide resolved

zzzLobster added 2 commits March 4, 2025 17:34

go.mod with replace

c74f883

updated Makefile to cover all modules

4e15905

samber approved these changes Mar 4, 2025

View reviewed changes

samber merged commit eeb65a7 into samber:main Mar 4, 2025
1 check passed

zzzLobster deleted the feat/zerolog branch March 5, 2025 06:23

Uh oh!

Add Zerolog formatter #50

Add Zerolog formatter #50

Uh oh!

Conversation

zzzLobster commented Mar 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zzzLobster commented Mar 3, 2025

Uh oh!

samber left a comment

Choose a reason for hiding this comment

Uh oh!

samber Mar 4, 2025

Choose a reason for hiding this comment

Uh oh!

zzzLobster Mar 4, 2025

Choose a reason for hiding this comment

Uh oh!

samber Mar 4, 2025

Choose a reason for hiding this comment

Uh oh!

samber Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zzzLobster Mar 4, 2025

Choose a reason for hiding this comment

Uh oh!

samber Mar 4, 2025

Choose a reason for hiding this comment

Uh oh!

zzzLobster Mar 4, 2025

Choose a reason for hiding this comment

Uh oh!

zzzLobster commented Mar 4, 2025

Uh oh!

Uh oh!

Uh oh!

samber commented Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

zzzLobster commented Mar 3, 2025 •

edited

Loading

samber Mar 4, 2025 •

edited

Loading

samber commented Mar 4, 2025 •

edited

Loading