Modify logger to print backtraces for critical messages #9105
Conversation
Additionally if a tool has any debugging turned on then print backtraces for error messages for that tool as well. Signed-off-by: Drew Lewis <[email protected]>
Signed-off-by: Drew Lewis <[email protected]>
Summary of ChangesHello @calewis, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly improves the diagnostic capabilities of the logging system by integrating stack trace printing for critical errors and for standard errors when debugging is active. This change leverages Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request successfully implements backtrace printing for critical messages, and for error messages when debugging is enabled, by leveraging the absl library. The refactoring of the utl library to isolate the TCL dependency is a clean and effective solution to the testing challenges you described. The new tests are comprehensive and validate the new functionality well. I've identified one high-severity bug in the error logging path that could lead to a runtime crash, and a couple of medium-severity suggestions to improve code quality and safety.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| #include <gtest/gtest.h> | ||
|
|
||
| #include "spdlog/sinks/ostream_sink.h" | ||
| #include "utl/Logger.h" |
There was a problem hiding this comment.
warning: included header ostream_sink.h is not used directly [misc-include-cleaner]
| #include "utl/Logger.h" | |
| #include "utl/Logger.h" |
| // Initialize absl symbolizer just for this test | ||
| static bool stack_trace_init = []() { | ||
| // On Linux, this falls back to /proc/self/exe, may fail on other platforms | ||
| absl::InitializeSymbolizer(nullptr); |
There was a problem hiding this comment.
warning: no header providing "absl::InitializeSymbolizer" is directly included [misc-include-cleaner]
src/utl/test/cpp/TestLoggerCriticalPrintsBackTrace.cpp:0:
- #include <gmock/gmock.h>
+ #include <absl/debugging/symbolize.h>
+ #include <gmock/gmock.h>Also, remove redundant calls to find_package(Boost...)
1 participant
Additionally if a tool has any debugging turned on then print backtraces for error messages for that tool as well.
Using absl backtrace utilities under the guise of eventually having fewer boost dependencies, but willing to change.
Very annoyingly the death test for backtraces in
criticalfail if TCL is linked (I guess TCL isn't very fork friendly or something). So to work around that I split off decode into its own library since it was the only user of TCL. I also removed the OSTA dependency for utl.After discussion I'll make it build for CMake and clean up a few things / make changes.