summaryrefslogtreecommitdiffstats
path: root/reference/logging-slf4j-demo/README.md
diff options
context:
space:
mode:
authorMichael O'Brien <frank.obrien@amdocs.com>2018-06-19 16:01:41 +0000
committerGerrit Code Review <gerrit@onap.org>2018-06-19 16:01:41 +0000
commit9aaa8f39949d7dc3d66888797951a20a7bced145 (patch)
tree37decda452c2426ec4baadcc82588193cb918b53 /reference/logging-slf4j-demo/README.md
parentf623a9882bfe2a3d2768f789223d430812569ee6 (diff)
parentbca830c8ee8cc574bd3f05e0599c56d05ba011e2 (diff)
Merge "Change MDC datetime formatter to Zulu time"
Diffstat (limited to 'reference/logging-slf4j-demo/README.md')
-rw-r--r--reference/logging-slf4j-demo/README.md31
1 files changed, 3 insertions, 28 deletions
diff --git a/reference/logging-slf4j-demo/README.md b/reference/logging-slf4j-demo/README.md
index 4434964..83f9f80 100644
--- a/reference/logging-slf4j-demo/README.md
+++ b/reference/logging-slf4j-demo/README.md
@@ -2,31 +2,6 @@
This project gives an example of ONAP-compliant logging using SLF4J logging.
-## Adapter
-
-In ```org.onap.logging.ref.slf4j.common```, there are TWO classes:
-1. ```org.onap.logging.ref.slf4j.common.ONAPLogConstants```, providing declarations of standard ONAP Markers, MDCs and HTTP headers.
-2. ```org.onap.logging.ref.slf4j.common.ONAPLogAdapter```, providing a lightweight, compliant implementation of the ONAP logging spec.
-
-The adapter provides:
-1. A loosely-coupled SLF4j logging wrapper:
- * To be used for logging ONAP ```entry```, ```exit``` and ```invoke``` behavior.
- * Devolving all *application* logging to the component, via the regular SLF4J ```Logger``` facade.
-2. Customization options:
- * *Cheap*, by way of bean properties. This is suited to most Use Cases.
- * *Sophisticated*:
- * By OPTIONALLY implementing one of a number of adapters:
- * ```RequestAdapter``` to read incoming headers.
- * ```ServiceDescriptor``` for reporting attributes of the current service.
- * ```ResponseDescriptor``` for reporting outcomes.
- * ```RequestBuilder``` for setting southbound request headers.
- * By OPTIONALLY overriding methods like ```ONAPLogAdapter#setMDCs(RequestAdapter)```.
-
-Note that:
-* The adapter implementation uses static inner classes in order to fit in a single source file. This was an objective.
-
-## WAR
-
Building produces a simple (spring-boot](https://projects.spring.io/spring-boot/) example WAR, which can be launched from this directory with:
```bash
@@ -45,6 +20,6 @@ The purpose of this WAR is to demonstrate minimalist ONAP-compliant logging for
## Tests
-Tests for:
-1. Code in the (potentially) reusable ``common`` package.
-2. Validating that emitted logs can be used to generate an unambiguous call graph.
+Tests for verifying that emitted logs can be used to generate an unambiguous call graph.
+
+Note that these run in-process, despite the WAR packaging. The intent is to enable tests via HTTP transports.