Exploratory logging documentation

AlbertaSat / ex3_documentation

All things documentation relating to software for the Ex3 mission, as well as generic flight software or linux concepts

2 stars 1 forks source link

Exploratory logging documentation #14

Open waridh opened 8 months ago

waridh commented 8 months ago

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 commented 8 months ago

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

dheadrick1618 commented 7 months ago

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 commented 7 months ago

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 commented 7 months ago

we may need another review