Logging Specification Compliance
- Prudence Au
- 1 Level 0: Log specification unchanged
- 2 Level 1: Log specification compliance via local project changes, library or wrapper
- 3 Level 2: Log specification compliance via SLF4J supplied logging-analytics library
- 4 Level 3: Log specification compliance via AOP library over SLF4J supplied logging-analytics library
TBU
For the casablanca release the logging specification has been updated and finalized as of June 2018. Implementation of this specification is required but the method of implementation is optional based on each team's level of possible engagement.
High Level the changes are introduction of MDC's (key/value pairs like requestID=...) and Markers (labels like ENTRY/EXIT)
The ELK stack (indexes and dashboards) is focused on the new specification in Casablanca - if time permits we will have a migration path and/or support for both the older Amsterdam/Beijing release and Casablanca - LOG-584: ELK stack indexes/dashboard alignment with new spec (MDCs, Markers)Closed
Level 0: Log specification unchanged
Just keep your code as-is and commit to migrating to the the MDC and Marker focused specification for Dublin - logs will be the older format for now
Level 1: Log specification compliance via local project changes, library or wrapper
Continue to use your own library/wrapper if you have one like in SDC and AAI, change individual source files.
Level 2: Log specification compliance via SLF4J supplied logging-analytics library
Use Luke's SLF4J library directly as wrapper for MDCs and Markers by calling the library from within each function.
Level 3: Log specification compliance via AOP library over SLF4J supplied logging-analytics library
Use a spring based Aspect library that emits Markers automatically around function calls and retrofit your code to log via Luke's SLF4J for internal log messages.