diff options
author | Brittany Plummer (bp896r) <bp896r@att.com> | 2019-08-27 15:36:44 -0400 |
---|---|---|
committer | Kevin Smokowski <kevin.smokowski@att.com> | 2019-08-29 20:37:00 +0000 |
commit | 5104a66d12a2ada0819d1cbcaf935785748f2b87 (patch) | |
tree | 1a48cbc173ff46060bbcf679f83a75a23d194df9 /reference/logging-filter/README.md | |
parent | ed4107f4ff0aa1ad65a96371bf69242847daedaa (diff) |
Add JAX-RS and Spring filters for setting up MDC
Issue-ID: LOG-1113
Change-Id: I7167943384e3983c7eced1c969ed51fcd8130c88
Signed-off-by: Brittany Plummer (bp896r) <bp896r@att.com>
Diffstat (limited to 'reference/logging-filter/README.md')
-rw-r--r-- | reference/logging-filter/README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/reference/logging-filter/README.md b/reference/logging-filter/README.md new file mode 100644 index 0000000..c861a54 --- /dev/null +++ b/reference/logging-filter/README.md @@ -0,0 +1,18 @@ +# Logging-Filter + +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. + +## Current Layout +- logging-filter (houses the parent pom) + - **base** this artifact should only depend on javax.servlet-api, javax.ws.rs-api, slf4j-api and org.onap.logging-analytics:logging-slf4j + - **spring** this artifact depends on base as well as spring. + +## Design Principles +- minimize dependencies for maximum re-use +- code to APIs jaxrs vs jersey, slf4j vs logback, etc... +- no application specific code in this library +- write extensible code so applications can add on application specific code +- target Casablanca logging spec + +## Code Formatting +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`
\ No newline at end of file |