Refactor: logging improvements #47
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
connected? is an alias to open? (which we already have)
it's confusing to have to check what they mean these map cleanly for the ConnectionFactory property names
to the LS plugin logger
which will log Java traces on unexpected errors
* master: CI: keep re-using base docker-compose.yml (logstash-plugins#48)
| ... sample recovery (debug) log (also notice the |
otherwise plugin.logger ignored error(e) calls
kares commented Jun 2, 2021
| # | ||
| # NOTE: effectively redirects MarchHare's default std-out logging to LS | ||
| # (MARCH_HARE_LOG_LEVEL=debug no longer has an effect) | ||
| connection.instance_variable_set(:@logger, LoggerAdapter.new(logger)) |
There was a problem hiding this comment.
we do not pass :logger => logger to MarchHare directly to avoid info logging a (less-relevant) message.
andsel approved these changes Jun 3, 2021
There was a problem hiding this comment.
LGTM
The only concern is that MarchHare logs goes under the logstash.inputs.rabbitmq logger and this could potentially confuse the user, like in:
[2021-06-03T15:20:08,118][DEBUG][logstash.inputs.rabbitmq ][main][e78725282315e2c8afc972c397af7c336f135c4040a5c8ef1e74617e63d75b55] session: instantiating a new connection using a set of addresses: localhost:5672 But now we can have that log the before got lost.
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.
Why is this important?
Currently the plugin does not gather logs from the underlying RabbitMQ library in LS' log.
Some debug logging by the frontend (
MarchHare) could be accessed (w an env property) but ends up on STDERR.This PR integrates the underlying logging to be part of LS' logging mechanism
The first change is to redirect
MachHare's logging to use theplugin.logger. This is useful for debug level logging, and respects the logging level set on the plugin.Second logging improvement is to disable MarchHare's logging 'improvement' and simply use the RabbitMQ's
ForgivingExceptionHandlerto log exceptions, these are redirected (using SLF4J bridge) to LS logs and for unexpected errors include Java traces.Finally, we slightly normalize the logging format on Ruby errors (till a proper logging support is provided by LS).
There's a few minor refactorings (HINT: we run integration specs), old option names such as
:timeoutcaused confusion in mapping the setting to the underlying RMQ ConnectionFactory property.