dev: Usage of InternalLogger and key values

[VLukasBecker]

Subject

Usage of the internal logger API and key values.

Description

Selected logmessages are switch to use the new internal Logger API. Values, which bevor where integrated in the message string, are now handled as key values.

Instructions for review / testing

• Check the changed log messages.

Developer checklist (address before review)

• Changelog.md updated
• Prepared update for depending repositories
• Documentation updated (public API changes only)
• API docstrings updated (public API changes only)
• Rebase → commit history clean
• Squash and merge → proper PR title

[KonradBkd]

This feature will add quite some benefit in debugging SIL Kit systems in the future!

I see two major points that needs some refactoring:

• Condense the logging "keys" to a seperate header which prevents typos and an overview of the available keys.
• Using an unordered_map for the storage of key+value seems reasonable for any subsequent analysis, but here it has a disadvantage: When collecting the pairs in the ServiceDescriptor::to_keyValues() and printing to the (stdout or file) log in KeyValuesToJsonString, we lose control over the order of pairs. E.g. in the Send / Recv logs the NetworkName should be at the beginning for readability. A std::map also doesn't help, as we want manual control over the order. Also, from what I see we never need the access by key, so we actually don't need the map. I suggest switching to a std::vector<std::pair<std::string, std::string>>, so we can define the iteration order via the insertion order.

More minor findings:

• Where used, double check if ILoggerInternal is really needed over ILogger. This got a litte bit confusing. Consider renaming to IStructuredLoggerInternal that it's more clear that this code part uses the structured logging.
• Few suggestions for SetMessage() wording
• Cleanup commented out code

[KonradBkd]

Two more things as discussed:

• No escaping in KeyValuesToSimpleString
• MessageBuffer Ser/Des for std::pair instead of std:vector<pair...

[KonradBkd]

LGTM now!

[KonradBkd]

RpcClient and Server were logging the wrong labels.

[KonradBkd]

👍

[MariusBgm]

We should discuss potential performance issues before merging

[MariusBgm]

LGTM!