Proposal of logging standard

[dekiel]

Description

The code maintained by neighbors team should provide consistent logging capabilities. The importance of proper logging does not require justification, however our tools implement different approach to this. Implementations provide different level of capabilities and use different tools or libraries, they use different formats and styles.

The logging standard must describe a minimal set of capabilities, a required formatting and style. It must describe an implementation to use. Wherever possible an example must be provided.

Reason

The logging experience in our tools is poor. It does not provide enough data for troubleshooting. Logging is implemented by using different libraries. The decisions on used logging solution is made by each developer in separation and on developed tool basis. This is the reason our logs are not sufficient for troubleshooting or auditing requirements. Multiple implementations increases complexity and maintain effort.

AC

• The logging standard is defined and accepted by the team.
• The logging standard is written down and maintained in github repository.
• The follow up issue to provide reference implementations are created and estimated.
• Standard provides links to the implementation.
• Standard provides example usage.

Proposal

Proposal draft: #12160