September 2021 - slf4j-dev - mailman3.qos.ch

[qos-ch/slf4j] 98f1f2: fix typo in version name
by Ceki Gulcu 27 Sep '21

27 Sep '21

Branch: refs/heads/master Home: https://github.com/qos-ch/slf4j Commit: 98f1f2f46533eba4945dda995225cf3c4017a075 https://github.com/qos-ch/slf4j/commit/98f1f2f46533eba4945dda995225cf3c4017… Author: Ceki Gulcu <ceki(a)qos.ch> Date: 2021-09-27 (Mon, 27 Sep 2021) Changed paths: M integration/pom.xml M jcl-over-slf4j/pom.xml M jul-to-slf4j/pom.xml M log4j-over-slf4j/pom.xml M osgi-over-slf4j/pom.xml M pom.xml M slf4j-api/pom.xml M slf4j-ext/pom.xml M slf4j-jdk-platform-logging/pom.xml M slf4j-jdk14/pom.xml M slf4j-log4j12/pom.xml M slf4j-migrator/pom.xml M slf4j-nop/pom.xml M slf4j-simple/pom.xml M slf4j-site/pom.xml Log Message: ----------- fix typo in version name Signed-off-by: Ceki Gulcu <ceki(a)qos.ch>

1 0

NDC Rehabilitation
by Michael Wooten 26 Sep '21

26 Sep '21

I originally opened SLF4J-522 to add a contains() method to the NDC class. I also opened a pull request on Github and had a brief discussion with Ceki on how I was using NDC vs. MDC. My reason for adding the contains() method was I was attempting to implement a library that offered similar functionality to how MDC behaves, specifically with how MDCCloseable can be used to provide a scope for a context. If an existing value already existed in the NDC, I did not want to add it again, and did not want to remove it. For another project, I originally implemented this by directly interfacing with the Log4J ThreadContext, but I would like to implement this using only SLF4J. There has been a trend away from nested diagnostic contexts to mapped ones, which for most cases makes perfect sense. I tend to use both for logging, but for different reasons. Obviously MDC is used to tag information pertinent to a specific instance (like a user ID, order ID, etc.). I tend to think of the mapped context as "what did we get at this logging statement". I typically use the nested context to push identifiers for the different parts of the system, which often correspond to different service layers. I treat the NDC as "how did we get to this logging statement". I often find it useful to know the path through the system to commonly used code, especially if it does not result in an Exception and stack trace. For instance, the NDC [ORDERS_ENDPOINT ORDER_RETURN USER_DAO] would likely be logged in a User DAO, but also indicates it was part of an order return. The NDC [USERS_ENDPOINT REGISTRATION USER_DAO] may be logged from the same statement, but indicates that it was part of a user registration request. I would like to propose several changes for NDC, but would also address several existing tickets in JIRA. 1. Move the NDC class from slf4j-ext to slf4j-api (SLF4J-447). 2. Update NDC to include new methods: a. String peek() - Returns the top context without removing it. b. boolean contains(String) - Returns whether the context stack contains the provided context (SLF4J-522) c. void clear() - Clears the complete context stack (SLF4J-244) 3. Update NDC to use a NDCAdapater similar to how MDC and MDCAdapter works. 4. Include a default NOPNDCAdapter that does nothing. I would also like to additionally propose several other improvements that affect both NDC and MDC. I would like to propose a ScopedLoggingContext class that implements Closeable that would remove potentially multiple MDC and NDC entries for a specific scope. I have implemented this before using a LoggingContext.Builder class that could be configured to add multiple entries to the NDC and MDC contexts. The class included both static and instance methods for updating the context and were meant to be chainable. It also implemented the Supplier interface and would only update the context when get() was called on it. Example: import static ...ScopedLoggingContext.Builder.nestedContext; try (Closeable c = nestedContext("REGISTRATION").mappedContext("ORDER_ID", order.getId()).mappedContext("USER_ID", order.getUserId()).get()) { logger.info("Logged with NDC and MDC values."); } This allows for the same try-with-resources block to add multiple nested or mapped context values and then remove them when the context is auto-closed. In the approach I implemented before, there were special semantics for values already on the NDC or MDC. For our purposes, the NDC did not allow for duplicate contexts (i.e. "[USER ORDERS USER]"). This may not be the case for others, and such a context may be useful. Also, our behavior for MDC was specified as if there was an existing MDC context value, it would be overwritten, but not removed from the context and its original value not restored. In our case this was beneficial since at some points a USER_ID context may be null and then later populated and it was beneficial for the same USER_ID to propagate to future logging statements. I understand that SLF4J-472 addresses the idea of the previous value being restored when the context is closed, and perhaps this is a behavior that could be toggled. In either case, I believe the current implementation of MDCCloseable could potentially be destructive if a nested context updated the same key value. try (MDC.MDCCloseable c1 = MDC.putCloseable("testKey", "value1")) { logger.info("Log message with context testKey=value1"); try (MDC.MDCCloseable c2 = MDC.putCloseable("testKey", "value2")) { logger.info("Log message with context testKey=value2"); } logger.info("Log message without context testKey"); } I would be willing to port my current work to SLF4J and post a PR if there is interest. Is there any interest in reviving and updating the nested diagnostic context? Is there any interest in being able to remove multiple context values (either from MDC or NDC) from a Closeable constructed via a Builder? If so, what should the behaviors be for duplicate context values? Thank you for any consideration, thoughts, or input on this suggestion. -Michael

1 0

[JIRA] Updates for SLF4J-522: Add contains() Method to NDC
by QOS.CH (JIRA) 10 Sep '21

10 Sep '21

SLF4J / SLF4J-522 [Open] Add contains() Method to NDC ============================== Here's what changed in this issue in the last few minutes. There is 1 comment. View or comment on issue using this link https://jira.qos.ch/browse/SLF4J-522 ============================== 1 comment ------------------------------ Ceki Gülcü on 10/Sep/21 6:41 PM I think NDC should perhaps be rehabilitated. Alternatively, MDC should be enhanced to support a stack stored under a key. ============================== This message was sent by Atlassian Jira (v8.8.0#808000-sha1:e2c7e59)

1 0

[JIRA] Updates for SLF4J-522: Add contains() Method to NDC
by QOS.CH (JIRA) 09 Sep '21

09 Sep '21

SLF4J / SLF4J-522 [Open] Add contains() Method to NDC ============================== Here's what changed in this issue in the last few minutes. This issue has been created This issue is now assigned to you. View or comment on issue using this link https://jira.qos.ch/browse/SLF4J-522 ============================== Issue created ------------------------------ Michael Wooten created this issue on 09/Sep/21 5:30 AM Summary: Add contains() Method to NDC Issue Type: Improvement Affects Versions: 2.0.0-alpha4 Assignee: SLF4J developers list Components: slf4j-ext Created: 09/Sep/21 5:30 AM Labels: logging nested Priority: Minor Reporter: Michael Wooten Severity: enhancement Description: I have been working on a library of utilities related to using SLF4J in different environments, and one functionality that I cannot seem to replicate is the ability to test if a value is already in the Nested Diagnostic Context. The only exposed public methods of the org.slf4j.NDC class are push(String) and pop(). There is a size() method that is private. I would like to propose the inclusion of a "boolean contains(String)" method that would return whether the currently configured NDC already includes the provided value. I understand with the current approach this would involve iterating over the MDC similar to how size() does since the NDC is actually emulated with MDC keys. ============================== This message was sent by Atlassian Jira (v8.8.0#808000-sha1:e2c7e59)

1 0

[qos-ch/slf4j] cf09b2: Class.getPackageName is new to JDK 9
by Ceki Gulcu 08 Sep '21

08 Sep '21

Branch: refs/heads/master Home: https://github.com/qos-ch/slf4j Commit: cf09b2e34de6216c9aa5b8ba5e7e5db3d5a4da27 https://github.com/qos-ch/slf4j/commit/cf09b2e34de6216c9aa5b8ba5e7e5db3d5a4… Author: Ceki Gulcu <ceki(a)qos.ch> Date: 2021-09-08 (Wed, 08 Sep 2021) Changed paths: M slf4j-simple/src/test/java/org/slf4j/simple/multiThreadedExecution/StateCheckingPrintStream.java Log Message: ----------- Class.getPackageName is new to JDK 9 Signed-off-by: Ceki Gulcu <ceki(a)qos.ch>

1 0

[qos-ch/slf4j] 1cea7b: removed link to instructions for contributors
by Ceki Gulcu 05 Sep '21

05 Sep '21

Branch: refs/heads/master Home: https://github.com/qos-ch/slf4j Commit: 1cea7b72e34854ca142cd08bc89f9f322b0c2290 https://github.com/qos-ch/slf4j/commit/1cea7b72e34854ca142cd08bc89f9f322b0c… Author: Ceki Gulcu <ceki(a)qos.ch> Date: 2021-09-05 (Sun, 05 Sep 2021) Changed paths: M slf4j-site/src/site/pages/templates/footer.js Log Message: ----------- removed link to instructions for contributors Signed-off-by: Ceki Gulcu <ceki(a)qos.ch>

1 0

[qos-ch/slf4j] 50a68f: tinkering with right.js
by Ceki Gulcu 03 Sep '21

03 Sep '21

Branch: refs/heads/master Home: https://github.com/qos-ch/slf4j Commit: 50a68fe8cc3680d1bc8281dccaa0ae72881539d2 https://github.com/qos-ch/slf4j/commit/50a68fe8cc3680d1bc8281dccaa0ae728815… Author: Ceki Gulcu <ceki(a)qos.ch> Date: 2021-09-03 (Fri, 03 Sep 2021) Changed paths: M slf4j-site/src/site/pages/templates/right.js Log Message: ----------- tinkering with right.js Signed-off-by: Ceki Gulcu <ceki(a)qos.ch>

1 0

[qos-ch/slf4j] 6f0c54: add jquery to pages
by Ceki Gulcu 03 Sep '21

03 Sep '21

Branch: refs/heads/master Home: https://github.com/qos-ch/slf4j Commit: 6f0c54caa4b339f285bf5e70d00741bc89c6ed4b https://github.com/qos-ch/slf4j/commit/6f0c54caa4b339f285bf5e70d00741bc89c6… Author: Ceki Gulcu <ceki(a)qos.ch> Date: 2021-09-03 (Fri, 03 Sep 2021) Changed paths: M slf4j-site/src/site/pages/bug-reporting.html M slf4j-site/src/site/pages/codes.html M slf4j-site/src/site/pages/docs.html M slf4j-site/src/site/pages/download.html M slf4j-site/src/site/pages/extensions.html M slf4j-site/src/site/pages/index.html M slf4j-site/src/site/pages/license.html M slf4j-site/src/site/pages/localization.html M slf4j-site/src/site/pages/mailing-lists.html M slf4j-site/src/site/pages/migrator.html M slf4j-site/src/site/pages/news.html M slf4j-site/src/site/pages/support.html M slf4j-site/src/site/pages/templates/right.js Log Message: ----------- add jquery to pages Signed-off-by: Ceki Gulcu <ceki(a)qos.ch>

1 0