Embrace Crystal standard Log for logging. #705
Merged
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
Kemal uses a LogHandler to log requests, this code predates the Crystal Log class so while the Kemal documentation says that logging is done using Log class, the http request log is done in a different way. This patch deprecates: - Kemal::Config#logger - Kemal::Config#logger=(Kemal::BaseLogHandler) - log(String) - Kemal::LogHandler.initialize(IO) - NullLogHandler and changes: - Add Kemal::Log (Log = ::Log.for(self)) - Kemal::LogHandler now uses Log. - No handler is created if logging is set to false. Old code using custom log handlers must work as before.
Sija
reviewed
Mar 21, 2025
0c937cc to
1b57c2f
Compare
1b57c2f to
8a365e5
Compare
hugopl
commented
Mar 31, 2025
straight-shoota
approved these changes
Apr 1, 2025
|
We've been using a custom class which Log.info do
JSON.build do |json|
json.object do
json.field "method", context.request.method
...
end
end
endIs there a recommended way to do something like this now that |
|
You can create a normal http handler and insert it on Kemal. Other day I was thinking about a way of ease this process by letting the user pass a proc to be used by the RequestLogHandler Log.info call. Maybe I will create a patch and request for comments. |
|
@hugopl Thanks -- I just made my custom logger a subclass of Good enough. Works for me 👍 |
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.
Description of the Change
Kemal uses a LogHandler to log requests, this code predates the Crystal Log class so while the Kemal documentation says that logging is done using Log class, the http request log is done in a different way.
This patch deprecates:
Kemal::LogHandler.initialize(IO)and changes:
Kemal::LogHandler now uses Log.Old code using custom log handlers must work as before.
Alternate Designs
Change nothing and follow with life.
Benefits
Unified log interface using the standard library Log facilities.
Possible Drawbacks
If there's some code usingLogHandler.new(io)the log wont be written toio, maybe I could keepLogHandleruntouched, just deprecated, and create a newRequestLogHandler.