Add JAX-RS and Spring filters for setting up MDC
[logging-analytics.git] / reference / logging-filter / README.md
1 # Logging-Filter
2
3 The base project is meant to have very minimal dependencies for maximum re-use. The spring artifact is provided for any clients already using spring.
4
5 ## Current Layout
6 - logging-filter (houses the parent pom)
7   - **base** this artifact should only depend on javax.servlet-api, javax.ws.rs-api, slf4j-api and org.onap.logging-analytics:logging-slf4j
8   - **spring** this artifact depends on base as well as spring.
9
10 ## Design Principles
11 - minimize dependencies for maximum re-use
12 - code to APIs jaxrs vs jersey, slf4j vs logback, etc...
13 - no application specific code in this library
14 - write extensible code so applications can add on application specific code
15 - target Casablanca logging spec
16
17 ## Code Formatting
18 ONAP code formatting standards are validated on builds. If you find a build failing due to a formatting issue, format your code by running `mvn process-sources -P format`