Skip to content
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.

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

refactor(log): restore customized nop logger #15257

Merged
merged 1 commit into from
Mar 3, 2023
Merged

Conversation

mark-rushakoff
Copy link
Member

Description

And clean up a couple benchmarks, to move unrelated allocations out of the hot loop.

The specialized nop logger runs about 3x faster than the zerolog wrapper around a zerolog.Nop instance.

Since the nop logger is part of the exported API, and since the implementation is very simple, we should continue to offer the faster version.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

And clean up a couple benchmarks, to move unrelated allocations out of
the hot loop.

The specialized nop logger runs about 3x faster than the zerolog wrapper
around a zerolog.Nop instance.

Since the nop logger is part of the exported API, and since the
implementation is very simple, we should continue to offer the faster
version.
@mark-rushakoff mark-rushakoff requested a review from a team as a code owner March 3, 2023 14:13
@github-actions github-actions bot added the C:log label Mar 3, 2023
@@ -62,7 +62,7 @@ func NewLoggerWithKV(key, value string) Logger {
return zeroLogWrapper{&logger}
}

// NewCustomLogger returns a new logger with the given zerolog logger
// NewCustomLogger returns a new logger with the given zerolog logger.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@julienrbrt godoc should be full, punctuated sentences.

When they are rendered on pkg.go.dev without punctuation, it looks sloppy, and it's not always clear if they are finished sentences.

Screen Shot 2023-03-03 at 9 14 11 AM

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure thing! I'll watch out, it does look sloppy without indeed 👍🏾

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is good to know, i bet there are many other areas we do this

@tac0turtle tac0turtle enabled auto-merge (squash) March 3, 2023 14:20
@tac0turtle tac0turtle merged commit 08be7ab into main Mar 3, 2023
@tac0turtle tac0turtle deleted the mr/custom-nop-logger branch March 3, 2023 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants