feat: entryhuman: Log the caller's relative module path and function #138
Conversation
This file contains 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
Some tools like modd (https://github.com/cortesi/modd) will try to color noncolored text but we don't want them to and so we reset at the beginning of each line to make sure they aren't playing with our output.
Instead of just their file's basename.
|
@nhooyr we use semantic to enforce standardized commit messages. Please update the title, and I'll merge! |
nhooyr
changed the title
|
@kylecarbs done! |
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.
At @terrastruct our codebase is currently structured in layers of similar package names and files.
So just printing the base file name for a log's location is vague.
This PR makes sloghuman print the module path to the file and even make it relative to the main module path
if possible. It also makes slog prints the originating function name.
See the test changes for how it looks for when the package is outside the main module.
Unfortunately
go testcurrently doesn't set the binaries build info correctly yet (golang/go#33976) so module paths in test logs will always be absolute. But this is how a relative path looks forcdr.dev/slog:->
cc @alixander