Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Disable file logging by default in Linux server. #129

Merged
merged 1 commit into from
Jan 25, 2024

Conversation

abeltrano
Copy link
Contributor

Type

  • Bug fix
  • Feature addition
  • Feature update
  • Documentation
  • Build Infrastructure

Side Effects

  • Breaking change
  • Non-functional change

Goals

Avoid logging to file when not necessary. Since we're mostly targeting distros with systemd, logging is not needed by default since stdout is collected by default and forwarded to the systemd journal, which can then be accessed with standardized tooling (eg. journalctl) and in mostly arbitrary formats (syslog, json, xml, etc.).

Technical Details

  • Avoid adding a rolling file logger unless explicitly requested via a new command-line argument --enable-file-logging, supported by a new field NetRemoteServerConfiguration::EnableFileLogging.

Test Results

  • Ran netremote-server --enable-file-logging <required args> and verified a log file was produced in the working directory.
  • Ran netremote-server <required args> and verified no log file was produced in the working directory.

Reviewer Focus

  • None

Future Work

  • None

Checklist

  • Build target all compiles cleanly.
  • clang-format and clang-tidy deltas produced no new output.
  • Newly added functions include doxygen-style comment block.

@abeltrano abeltrano requested a review from a team as a code owner January 25, 2024 02:45
@abeltrano abeltrano merged commit 373506b into develop Jan 25, 2024
4 checks passed
@abeltrano abeltrano deleted the nofilelogdefault branch January 25, 2024 02:46
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