Skip to content

Implement syslog level mappings in formatter#122

Draft
JonathanWilbur wants to merge 2 commits into
dahlia:mainfrom
JonathanWilbur:patch-2
Draft

Implement syslog level mappings in formatter#122
JonathanWilbur wants to merge 2 commits into
dahlia:mainfrom
JonathanWilbur:patch-2

Conversation

@JonathanWilbur

Copy link
Copy Markdown
Contributor

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.

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.
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @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 SyslogLevelPrefix parameter, ensuring better compatibility and standardized logging output.

Highlights

  • Syslog Level Mappings: Introduced new mappings for log levels (trace, debug, info, warning, error, fatal) to their corresponding Syslog priority values (e.g., <7>, <6>, <4>, <3>, <0>).
  • Formatter Integration: The getTextFormatter function now supports a 'syslog' option, allowing log messages to be formatted with the new Syslog priority prefixes.

🧠 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 Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

It sounds like "emerg" is more suitable for when the whole host system is broken

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment on lines +446 to +447
} else if (levelOption === "syslog") {
return (level: LogLevel): string => levelRenderersCache.syslog[level];

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

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".

Comment on lines +446 to +447
} else if (levelOption === "syslog") {
return (level: LogLevel): string => levelRenderersCache.syslog[level];

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

This is a great feature for systemd integration, but it has a couple of issues that prevent it from working out-of-the-box:

  1. Missing Tests: No unit tests have been added in formatter.test.ts to verify this new syslog level option. Please add tests to ensure it works correctly.

  2. Incorrect Default Output: The default format function 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 custom format function.

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}.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant