adds std lib slog logger to knapsack #1419
Merged
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
James-Pickett
commented
Oct 23, 2023
cmd/launcher/launcher.go
Outdated
Comment on lines
185
to
186
| // system log | ||
| k.AddReplaceSlogHandler("system", slog.NewJSONHandler(os.Stderr, &slog.HandlerOptions{ |
There was a problem hiding this comment.
This probably won't work for windows.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
James-Pickett
changed the title
RebeccaMahany
approved these changes
Oct 31, 2023
zackattack01
approved these changes
Oct 31, 2023
directionless
approved these changes
Oct 31, 2023
| case "error": | ||
| ls.slogLevel.Set(slog.LevelError) | ||
| case "default": | ||
| ls.knapsack.Slogger().Error("unrecognized flag value for log shipping level", |
There was a problem hiding this comment.
Ha! I love that we can use knapsack.Slogger here.
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.
This PR add a std lib slog logger to knapsack accessible via
Knapsack.Slogger()andKnapsack.SystemSlogger(). The knapsack logger writes to all the same destinations as our existing loggers. To do this I had to expose the writers in various places to pass to slog log handlers. It's kinda weird, but I couldn't find a better way.The stdlib does not include any support for tee logging. So to achieve something similar you can have a single logger write to multiple handlers or more accurately give the logger a handler that will fan out to other handlers. We could write our own handler to do this, but I found a sufficient one here.
We could do more advanced things with these handlers like determining if we want to send debug logs based on log attributes ie. only ship debug logs for nababe. However, to reduce complexity of the PR, I didn't add any fancy stuff.
Tested that logging works for:
Example slog output
{ "time": "2023-10-20T11:24:59.531839Z", "level": "INFO", "source": { "function": "main.runLauncher.func2", "file": "/Users/jamespickett/Documents/repos/james-launcher/cmd/launcher/launcher.go", "line": 195 }, "msg": "slog test with", "logger": "knapsack" }