[#4] Introduce developer guide with log documentation

[elfenpiff]

Notes for Reviewer

A detailed documentation about logging (and also how to handle errors since they are tightly coupled to logging) in iceoryx2.

Pre-Review Checklist for the PR Author

1. Add sensible notes for the reviewer
2. PR title is short, expressive and meaningful
3. Relevant issues are linked in the References section
4. Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT
5. Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
6. Commits messages are according to this guideline
   • Commit messages have the issue ID ([#123] Add posix ipc example)
   • Commit author matches Eclipse Contributor Agreement (and ECA is signed)
7. Tests follow the best practice for testing
8. Changelog updated in the unreleased section including API breaking changes
9. Assign PR to reviewer
10. All checks have passed (except task-list-completed)

Checklist for the PR Reviewer

• Commits are properly organized and messages are according to the guideline
• Unit tests have been written for new behavior
• Public API is documented
• PR title describes the changes

Post-review Checklist for the PR Author

1. All open points are addressed and tracked via issues

References

Relates to #4

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.95%. Comparing base (e5b44a9) to head (3f4dd87).
Report is 7 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #469      +/-   ##
==========================================
- Coverage   79.08%   78.95%   -0.13%     
==========================================
  Files         196      197       +1     
  Lines       23572    23637      +65     
==========================================
+ Hits        18641    18663      +22     
- Misses       4931     4974      +43     

see 5 files with indirect coverage changes

[orecham]

LGTM

[elBoberido]

Not in this PR but would it be possible to have the actual log message before the origin?

I volunteer to change this, if you agree

[elfenpiff]

Why? For me it feels wrong but if @orecham also prefers to switch the output order of the console logger I would go with the flow.

[elBoberido]

Because it feels like yoda notation 😅

At first it's the log level, e.g. [W]. Then it's the context, but for what? Finally, it's the actual log message and the context becomes meaningful but one has to scroll back to the top.

I would even change the format to this in order to have a clean separation between log message and context

0 [T] opened
      === Context ===
      FileBuilder { file_path: FilePath { value: FixedSizeByteString<255> {   |
      len: 20, data: "config/iceoryx2.toml" } }, access_mode: Read,           |
      permission: Permission(448), has_ownership: false, owner: None,         |
      group: None, truncate_size: None, creation_mode: None } 

Instead of ### Context ### something like ======== would also work.