hook: introduce mechanism for hooking into raw logger output #55
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #55 +/- ##
==========================================
+ Coverage 59.83% 60.16% +0.32%
==========================================
Files 15 16 +1
Lines 600 615 +15
==========================================
+ Hits 359 370 +11
- Misses 220 222 +2
- Partials 21 23 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
0xnmn
approved these changes
Feb 3, 2023
sashaostrikov
approved these changes
Feb 3, 2023
hook/writer.go
Outdated
|
|
||
| // Writer hooks receiver to rendered log output at level in the requested format, | ||
| // typically one of 'json' or 'console'. | ||
| func Writer(logger log.Logger, receiver io.Writer, level log.Level, format string) log.Logger { |
Contributor
There was a problem hiding this comment.
nit: we can create a type and consts for format and use it instead of string.
However, I can see that you had a type and changed it to string :) But I think having our own type (aliasing string) shouldn't cause any problems?
Member
Author
There was a problem hiding this comment.
The type was internal - let me try and move it around :)
Member
Author
There was a problem hiding this comment.
Took a bit of shuffling but here we go: 4373c5e
jhchabran
approved these changes
Feb 3, 2023
Co-authored-by: Alex Ostrikov <alexander.ostrikov.jr@gmail.com>
This was referenced Feb 3, 2023
bobheadxi
added a commit
to sourcegraph/sourcegraph-public-snapshot
that referenced
this pull request
Feb 7, 2023
Includes: - sourcegraph/log#56 - sourcegraph/log#55 - https://github.com/sourcegraph/run/releases/tag/v0.10.0 - https://github.com/sourcegraph/run/releases/tag/v0.11.0 - https://github.com/sourcegraph/run/releases/tag/v0.12.0 Also updates deprecated usages (seems we have a linter requiring this now)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A use case for this came up before (https://github.com/sourcegraph/sourcegraph/pull/45229), and @thenamankumar inquired about similar capabilities today for tracking log entries into a database. I think this may be a valid use case to support and simple enough to provide:
This makes it easy for consumers to record log output in a format consistent with what gets rendered by the library.
For convenience, log output format is now exported via
log/output.Format.I also think it makes sense for this to exist separately from
logtest.CaptureLog-logtestexports log entries in a structured manner for assertions, but we don't really want production code to be treating log entries as structured data (we could, but that might be a larger debate) - this serves simply to tee output elsewhere for recordkeeping.