Adding structured logging helper #614
Open
+591
−0
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 #614 +/- ##
==========================================
+ Coverage 73.67% 74.21% +0.54%
==========================================
Files 35 36 +1
Lines 1341 1404 +63
==========================================
+ Hits 988 1042 +54
- Misses 277 286 +9
Partials 76 76 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
bmoffatt
requested changes
Jan 14, 2026
lambdacontext/logger.go
Outdated
| } | ||
|
|
||
| // Attrs returns Lambda context fields as slog-compatible key-value pairs. | ||
| // For most use cases, using [Handler] with slog.InfoContext is preferred. |
Collaborator
There was a problem hiding this comment.
TIL slog.InfoContext/WarnContext/etc
- Rename Handler() to LogHandler() - Rename LogFormatName/LogLevelName to LogFormat/LogLevel - Use functional options pattern with WithFields() - Use Field functions (FieldFunctionARN, FieldTenantID) for immutability - Add example tests in separate file with go1.21 build tag
bmoffatt
reviewed
Jan 14, 2026
| // | ||
| // By default, only requestId is injected. Use WithFields to include more. | ||
| // See the package examples for usage. | ||
| func LogHandler(opts ...LogOption) slog.Handler { |
Collaborator
There was a problem hiding this comment.
NewLogHandler would be consistent with other constructors
bmoffatt
reviewed
Jan 14, 2026
| // The handler automatically injects requestId from Lambda context into each log record. | ||
| func ExampleLogHandler() { | ||
| // Set up the Lambda-aware slog handler | ||
| slog.SetDefault(slog.New(lambdacontext.LogHandler())) |
Collaborator
There was a problem hiding this comment.
Thinking to simplify this to slog.SetDefault(lambdacontext.NewLogger()) where NewLogger returns a *slog.Logger.
bmoffatt
reviewed
Jan 14, 2026
Comment on lines
+31
to
+33
| slog.SetDefault(slog.New(lambdacontext.LogHandler( | ||
| lambdacontext.WithFields(lambdacontext.FieldFunctionARN(), lambdacontext.FieldTenantID()), | ||
| ))) |
Collaborator
There was a problem hiding this comment.
I think I'd prefer just option functions that setup the fields, rather than a fields option. To reduce the line noise and nesting.
lambdacontext.LogHandler(
lambdacontext.WithFunctionARN(),
lambdacontext.WithTenantID(),
)
func WithFunctionARN() LoggerOption {
return func(*loggerOptions) {
o.fields = append(o.fields, field{"functionArn", func(lc *LambdaContext) string { return lc.InvokedFunctionArn } }
}
}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Issue #, if available:
Description of changes:
Adding helper for structured logging so users can log as JSON with slog easier than before.
LogFormatNameandLogLevelNameare added tocontext.goas well so it can be easier and cleaner to setup a structured logger as well.Tests:
Added tests for
logger.goBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.