Conversation

As an ONAP component developer, I want reference examples demonstrating best practices.

Conversation

The purpose of reference examples is to provide canonical examples of the use of key MDCs and attributes, and to provide code examples for use in guidelines. Cross-references can be made between code and guidelines. 

The intention is to have:

1. A reference component which uses EELF. 
2. A reference component which uses SLF4J directly, without EELF. 
3. An existing ONAP component which conforms. (A&AI was suggested). 

A key aspect of logging guidelines is the passing of information between components during REST invocation and response. This means examples should consist of TWO ONAP-like components, so as to provide examples of invocation and response. 

Other requirements and non-requirements:

1. Examples need not implement auth* of any kind. 
2. Examples need not use Spring Boot, and certainly not AJSC. Just a WAR in a Jetty container will do nicely. 
3. Provider config should be canonical:
   1. Examples should read configuration from a file at the standard location. 
   2. Examples should output logfiles to the standard locations
4. Examples should include a test suite. Running the test suite should produce and validate logger output. 
5. Examples should be packaged so as to be runnable in Docker. 

This ties in nicely with reference provider configuration for Logback and Log4j. Reference examples need only use one or the other. (And presumably that means Logback). See LOG-106.