support/http: allow services to specify the logger used by the logging middleware #2314
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.
PR Checklist
PR Structure
otherwise).
services/friendbot
, orall
ordoc
if the changes are broad or impact manypackages.
Thoroughness
.md
files, etc... affected by this change). Take a look in the
docs
folder for a given service,like this one.
Release planning
needed with deprecations, added features, breaking changes, and DB schema changes.
semver, or if it's mainly a patch change. The PR is targeted at the next
release branch if it's not a patch change.
What
Allow services to specify the logger used by the logging middleware.
Why
LoggingMiddleware
gets the logger from the context using"support/log".Ctx(...)
. If none is specified in the context the"support/log".DefaultLogger
is used. Because theLoggingMiddleware
is placed into thechi.Mux
in theNewMux
andNewAPIMux
functions a service using these functions has no opportunity to set a logger on the context because a middleware cannot be inserted earlier. This means by usingNewMux
andNewAPIMux
you are stuck with the default logger.Why Behind the Why
The reason I'm wanting this is because
webauth
andrecoverysigner
are similar toticker
in that they explicitly define all their dependencies and pass them down to the code using them as explicitly as possible. Because of this both of those applications define their own logger. Because we have some code like the LoggingMiddleware that magically pulls the logger out of the context setting it in the context is the only way to fully use a custom logger.Alternative Implementations
If you look at the commits on this PR I attempted to implement this one way first using functional options. It seems pretty cool 😎 but more complicated that is necessary so I dropped it.
Known limitations
N/A