Log entry markup

Earlier this year, I worked for an engineer by the name of Tushar. He’s a very bright guy and probably one of the best software engineers I’ve ever worked with. He uses the following ‘mark-up’ scheme to help identify log file entries.

=== Marks the start of a process (where a process may comprise several methods/objects).
Information; useful information that isn’t an error
>>> Marks the start of a function/method
<<< Marks the end of a function/method
ooo Warning: A warning entry; more serious than ‘Information’ but less serious than an error
*** An error or exception

When you’re formatting your log entry, simply add the appropriate marker at the beginning of the string.

Advertisements