Implement syslog level mappings in formatter#122
Conversation
Added syslog level mappings for trace, debug, info, warning, error, and fatal. These are documented here: https://www.freedesktop.org/software/systemd/man/latest/sd-daemon.html# And they are can be used in Systemd via [this](https://www.freedesktop.org/software/systemd/man/latest/systemd.exec.html#SyslogLevelPrefix=) parameter.
Summary of ChangesHello @JonathanWilbur, 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 enhances the log formatter by implementing standard Syslog level mappings. This change enables log levels to be represented using Syslog priority values, which is particularly useful for integration with systems like Systemd that utilize the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. 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
|
It sounds like "emerg" is more suitable for when the whole host system is broken
There was a problem hiding this comment.
Code Review
This pull request introduces syslog level mappings to the text formatter, a valuable addition for systemd integration. The core implementation is sound, but there are several areas that need attention before this can be merged. Specifically, the TextFormatterOptions type needs to be updated to include the new "syslog" option, unit tests are missing, the default format doesn't produce systemd-compatible output, and the documentation has not been updated. I've left detailed comments on the code with suggestions for these improvements.
| } else if (levelOption === "syslog") { | ||
| return (level: LogLevel): string => levelRenderersCache.syslog[level]; |
There was a problem hiding this comment.
While this correctly handles the syslog option at runtime, the level property in the TextFormatterOptions interface (defined on lines 161-168) has not been updated to include "syslog". This will cause a type error for TypeScript users trying to use this new feature. Please update the type definition to include "syslog".
| } else if (levelOption === "syslog") { | ||
| return (level: LogLevel): string => levelRenderersCache.syslog[level]; |
There was a problem hiding this comment.
This is a great feature for systemd integration, but it has a couple of issues that prevent it from working out-of-the-box:
-
Missing Tests: No unit tests have been added in
formatter.test.tsto verify this newsysloglevel option. Please add tests to ensure it works correctly. -
Incorrect Default Output: The default
formatfunction wraps the log level in square brackets, which would result in output like[<6>]. For systemd integration, the prefix should be just<6>at the start of the line. The current implementation doesn't work as expected for the intended use case without a customformatfunction.
Consider adjusting the default formatter when options.level === 'syslog' to provide a better out-of-the-box experience. For example, the format could be ${level}${message}.
Added syslog level mappings for trace, debug, info, warning, error, and fatal.
These are documented here: https://www.freedesktop.org/software/systemd/man/latest/sd-daemon.html#
And they are can be used in Systemd via this parameter.