Misc tracing improvements #906
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #906 +/- ##
==========================================
- Coverage 94.53% 94.50% -0.03%
==========================================
Files 56 56
Lines 10140 10126 -14
==========================================
- Hits 9586 9570 -16
- Misses 554 556 +2 ☔ View full report in Codecov by Sentry. |
danielocfb
force-pushed
the
topic/tracing-improvements
branch
3 times, most recently
from
6f939f7
to
8a78dd6
Compare
The Debug representation of ElfResolver looks awkward and not in line with how objects are generally represented. Fix it up to make traces somewhat more appealing to the eye. Signed-off-by: Daniel Müller <[email protected]>
From the point of view of a user, the Resolver enum has no meaning: it's pretty much just an implementation detail of how we manage memory. As such, all the current representation in traces does is add clutter. Simplify it by only printing the inner value (i.e., the resolver). Signed-off-by: Daniel Müller <[email protected]>
We document supported "formats" not just in the README but also in the Symbolizer type's documentation. Mirror what commit a9d9811 ("Add BPF programs to "format" matrix in README") did to the README there as well, to keep both matrices in sync. Signed-off-by: Daniel Müller <[email protected]>
The ElfResolver::find_sym trace point doesn't really buy us anything: other resolvers don't have it and we effectively already have the functionality captured by the trace in Symbolizer::symbolize_with_resolver. As such, let's just remove it. Signed-off-by: Daniel Müller <[email protected]>
The occurrence of errors is generally something that we should include in our traces, but doing so requires special annotation. Add it to relevant entry points to the crate. The created spans/events will be emitted at log level ERROR by default, which is what we want. Signed-off-by: Daniel Müller <[email protected]>
It can be useful for introspection matters to get a quick understanding of what /proc/<pid>/maps entry an address gets mapped to as part of process symbolization. Attach a span to the handle_entry_addr() method to emit this information. Signed-off-by: Daniel Müller <[email protected]>
Make sure that we capture the reason why a symbolization maps to "unknown" in traces, as that can be relevant information when trying to understand what the library is reporting. Signed-off-by: Daniel Müller <[email protected]>
danielocfb
force-pushed
the
topic/tracing-improvements
branch
from
8a78dd6
to
6b39bf2
Compare
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.
Please see individual commits for descriptions.