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

Exploratory logging documentation #14

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

waridh
Copy link

@waridh waridh commented Jan 24, 2024

What is this?

  • Exploratory documentation into Linux logging, which includes general concepts of user and kernel logging along with some syslog protocol concepts.
  • Details will be somewhat sparse.

Future works

  • Increase the amount of information on syslog.
  • More research on alternate implementation of logging.
  • Find out what is most portable to the version of linux being used on the OBC.

@waridh waridh self-assigned this Jan 24, 2024
@waridh waridh changed the title Bach/documentation/logging Exploratory logging documentation Jan 24, 2024
@waridh
Copy link
Author

waridh commented Jan 24, 2024

If the quality of the documentation is not good enough, I could spend more time making it better.

dheadrick1618
dheadrick1618 previously approved these changes Jan 30, 2024
Copy link
Member

@dheadrick1618 dheadrick1618 left a comment

Choose a reason for hiding this comment

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

Good work! Looking forward to seeing what comes of the example program. I created an issue you can tie the syslog branch too if you'd like.

### Log rotation

- The syslog daemon will rotate log files out of use every week. Once the
log file is two weeks old, the log file will get archived into a `.gz`.
Copy link
Member

Choose a reason for hiding this comment

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

Is this configurable? We may want to store gzips of sys logs over more particular intervals like every 'N' orbits completed.

Copy link
Author

Choose a reason for hiding this comment

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

Yes, in my reading there was a way to configure rsyslog.

@dheadrick1618
Copy link
Member

If the quality of the documentation is not good enough, I could spend more time making it better.

No it's fine I think j moving forward it would be best to demonstrate things with a working example. I found this great article comparing various logging options in rust. https://www.shuttle.rs/blog/2023/09/20/logging-in-rust.

@waridh
Copy link
Author

waridh commented Jan 30, 2024

If the quality of the documentation is not good enough, I could spend more time making it better.

No it's fine I think j moving forward it would be best to demonstrate things with a working example. I found this great article comparing various logging options in rust. https://www.shuttle.rs/blog/2023/09/20/logging-in-rust.

This article is beautiful. Maybe I'll add this to the PR before rebasing it into the main branch?

@waridh
Copy link
Author

waridh commented Jan 30, 2024

we may need another review

- [Stackify guide on how syslog works](https://stackify.com/syslog-101/)
- [Syslog Protocol](https://datatracker.ietf.org/doc/rfc5424/)
- [Rust Syslog Library](https://docs.rs/syslog/latest/syslog/)
- [Other Rust logging methods](https://www.shuttle.rs/blog/2023/09/20/logging-in-rust)
Copy link
Author

Choose a reason for hiding this comment

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

This is the added line

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants