Improve exception logging #1992
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
This allows us to distinguish which product is originating the failed requests, e.g.: ``` ERROR -- ddtrace: [ddtrace] (.../client.rb:38:in `rescue in send_request') Internal error during Datadog::Profiling::Transport::HTTP::Client request. ``` for profiling.
Ruby exceptions can have really confusing, vague, or even empty messages. To help us out during debugging, I've added the exception class in exception-related logs to give us more context while debugging issues. This is quite low-hanging fruit, but I think in general we have a long way to go in improving exception logging in dd-trace-rb. In particular, we should probably look into centralizing exception logging in a method to solve the following: * Eliminate duplication. Can you spot how often I had to copy paste `e.class.name` in this PR? * There's a few cases where we just log the message, without any context. (I did not touch those) * The formatting of our error messages is quite inconsistent. Sometimes we include the backtrace, sometimes not. Sometimes we call the backtrace location, sometimes source, etc. * Sometimes we call the logger with a block (so that the string does not need to be generated if logging is disabled at that level), sometimes we just pass in a string. * There is no way to get the full stack trace, if we need to know more about where an error came from. But... for now here's a smaller improvement.
lloeki
approved these changes
Apr 29, 2022
|
Cool! I'll hold off on pressing the magic button so we can finish putting 1.0.0 out :) |
marcotc
approved these changes
Apr 29, 2022
delner
reviewed
May 3, 2022
It does, a lot! But improving this is a bit of a rabbit hole, so I decided to take a small step, and leave further improvements for the future :) |
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.
Ruby exceptions can have really confusing, vague, or even empty messages.
To help us out during debugging, I've added the exception class in exception-related logs to give us more context while debugging issues.
This is quite low-hanging fruit, but I think in general we have a long way to go in improving exception logging in dd-trace-rb.
In particular, we should probably look into centralizing exception logging in a method to solve the following:
Eliminate duplication. Can you spot how often I had to copy paste
e.class.namein this PR?There's a few cases where we just log the message, without any context. (I did not touch those)
The formatting of our error messages is quite inconsistent. Sometimes we include the backtrace, sometimes not. Sometimes we call the backtrace location, sometimes source, etc.
Sometimes we call the logger with a block (so that the string does not need to be generated if logging is disabled at that level), sometimes we just pass in a string.
There is no way to get the full stack trace, if we need to know more about where an error came from.
But... for now here's a smaller improvement.