From 0427fedc27e92bbecdb721ff95e1108dbb1d1a29 Mon Sep 17 00:00:00 2001 From: Fiete Ostkamp Date: Fri, 28 Feb 2025 15:43:42 +0100 Subject: Update logback - update logback (1.2.3 -> 1.2.13) - fix docs - this is just done to have a change that can be released as 1.2.10 Issue-ID: LOG-1245 Change-Id: I1114f35d7fe95d2cede15f1fd2d05916b52d3714 Signed-off-by: Fiete Ostkamp --- .../logging_enhancements_project.rst | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) (limited to 'docs/Logging_Enhancements_Project') diff --git a/docs/Logging_Enhancements_Project/logging_enhancements_project.rst b/docs/Logging_Enhancements_Project/logging_enhancements_project.rst index c74535a..81476f0 100644 --- a/docs/Logging_Enhancements_Project/logging_enhancements_project.rst +++ b/docs/Logging_Enhancements_Project/logging_enhancements_project.rst @@ -81,7 +81,7 @@ components involved in its processing. A reference configuration of \ `*Elastic Stack * `__\ can be deployed using \ `*ONAP Operations -Manager* `__. +Manager* `__. This document gives conventions you can follow to generate conformant, indexable logging output from your component. @@ -121,7 +121,7 @@ EELF is a facade, so logging output is configured in two ways: 2. By way of a provider configuration document, typically \ **logback.xml** or **log4j.xml**. - See \ `*Providers* `__. + See \ `*Providers* `__. **SLF4J** @@ -151,7 +151,7 @@ abstracted behind EELF or SLF4J, it may not be worth the effort. Logback is the most commonly used provider. It is generally configured by an XML document named \ **logback.xml**. -See \ `*Configuration* `__. +See \ `*Configuration* `__. **Log4j 2.X** @@ -159,7 +159,7 @@ See \ `*Configuration* `__. +named \ **log4j.xml**. See \ `*Configuration* `__. **Log4j 1.X** @@ -171,10 +171,10 @@ machine-readable. See \ `*https://logging.apache.org/log4j/1.2/* `__ bundle +to \ `*Carbon* `__ bundle Log4j 1.X, and make it difficult to replace. The \ `*Common Controller SDK -Project* `__ project +Project* `__ project targets ODL Carbon, so the problem should resolve in time. What to Log @@ -231,7 +231,7 @@ A Mapped Diagnostic Context (MDC) allows an arbitrary string-valued attribute to be attached to a Java thread. The MDC's value is then emitted with each log message. The set of MDCs associated with a log message is serialized as unordered name-value pairs (see `*Text -Output* `__). +Output* `__). A good discussion of MDCs can be found at \ `*https://logback.qos.ch/manual/mdc.html* `__. @@ -976,24 +976,24 @@ You must: 1. Choose a Logging provider and/or EELF. Decisions, decisions. 2. Create a configuration file based on an existing - archetype. See \ `*Configuration* `__. + archetype. See \ `*Configuration* `__. 3. Read your configuration file when your components initialize logging. 4. Write logs to a standard location so that they can be shipped by Filebeat for indexing. See \ `*Output - Location* `__. + Location* `__. 5. Report transaction state: a. Retrieve, default and propagate \ **RequestID**. See \ `*MDC - - RequestID* `__. + RequestID* `__. b. At each invocation of one ONAP component by another: i. Initialize and propagate \ **InvocationID**. See \ `*MDC - Invocation - ID* `__. + ID* `__. ii. Report \ **INVOKE** and **SYNCHRONOUS** markers in caller. -- cgit