BAEL-40: Add NDC and JBoss Logging to the demo application (#880)

* Add NDC and JBoss Logging to the demo application

* NDC for Log4j, Log4j2 and JBoss Logging

* Simplify NDC example by making it a single operation instead of two

* Make NDC example as RestController, Use JBoss Logging only as a logging bridge

* Fix merge conflicts in pull request - log-mdc pom.xml updated

log-mdc/pom.xml

@@ -5,20 +5,37 @@
 	<artifactId>logmdc</artifactId>
 	<version>0.0.1-SNAPSHOT</version>
 	<name>logmdc</name>
-	<description>tutorial on logging with MDC</description>
+    <packaging>war</packaging>
+	<description>tutorial on logging with MDC and NDC</description>
 
 	<dependencies>
 
-		<dependency>
+        <dependency>
-			<groupId>org.springframework</groupId>
+            <groupId>org.springframework</groupId>
-			<artifactId>spring-context</artifactId>
+            <artifactId>spring-core</artifactId>
-			<version>${springframework.version}</version>
+            <version>${springframework.version}</version>
-		</dependency>
+        </dependency>
-		<dependency>
+        <dependency>
-			<groupId>org.springframework</groupId>
+            <groupId>org.springframework</groupId>
-			<artifactId>spring-webmvc</artifactId>
+            <artifactId>spring-web</artifactId>
-			<version>${springframework.version}</version>
+            <version>${springframework.version}</version>
-		</dependency>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-webmvc</artifactId>
+            <version>${springframework.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>javax.servlet</groupId>
+            <artifactId>javax.servlet-api</artifactId>
+            <version>${javax.servlet.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>${jackson.library}</version>
+        </dependency>
 
 		<!--log4j dependencies -->
 		<dependency>
@@ -31,12 +48,12 @@
 		<dependency>
 			<groupId>org.apache.logging.log4j</groupId>
 			<artifactId>log4j-api</artifactId>
-			<version>2.7</version>
+			<version>${log4j2.version}</version>
 		</dependency>
 		<dependency>
 			<groupId>org.apache.logging.log4j</groupId>
 			<artifactId>log4j-core</artifactId>
-			<version>${log4j-api.version}</version>
+			<version>${log4j2.version}</version>
 		</dependency>
 
 		<!--disruptor for log4j2 async logging -->
@@ -52,6 +69,13 @@
 			<artifactId>logback-classic</artifactId>
 			<version>${logback.version}</version>
 		</dependency>
+
+        <!-- JBoss Logging (bridge) dependencies -->
+        <dependency>
+            <groupId>org.jboss.logging</groupId>
+            <artifactId>jboss-logging</artifactId>
+            <version>${jbosslogging.version}</version>
+        </dependency>
 		
 		<dependency>
 		    <groupId>junit</groupId>
@@ -59,15 +83,51 @@
 		    <version>${junit.version}</version>
 		    <scope>test</scope>
 		</dependency>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-test</artifactId>
+            <version>${springframework.version}</version>
+            <scope>test</scope>
+        </dependency>
 		
 	</dependencies>
 
     <properties>
         <springframework.version>4.3.4.RELEASE</springframework.version>
         <log4j.version>1.2.17</log4j.version>
-        <log4j-api.version>2.7</log4j-api.version>
+        <log4j2.version>2.7</log4j2.version>
         <disruptor.version>3.3.6</disruptor.version>
         <logback.version>1.1.7</logback.version>
+        <jbosslogging.version>3.3.0.Final</jbosslogging.version>
+        <javax.servlet.version>3.1.0</javax.servlet.version>
+        <jackson.library>2.8.5</jackson.library>
         <junit.version>4.12</junit.version>
     </properties>
-</project>
+
+    <build>
+        <pluginManagement>
+            <plugins>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-compiler-plugin</artifactId>
+                    <version>3.2</version>
+                    <configuration>
+                        <source>1.8</source>
+                        <target>1.8</target>
+                    </configuration>
+                </plugin>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-war-plugin</artifactId>
+                    <version>2.4</version>
+                    <configuration>
+                        <warSourceDirectory>src/main/webapp</warSourceDirectory>
+                        <warName>logging-service</warName>
+                        <failOnMissingWebXml>false</failOnMissingWebXml>
+                    </configuration>
+                </plugin>
+            </plugins>
+        </pluginManagement>
+        <finalName>logging-service</finalName>
+    </build>
+</project>

log-mdc/src/main/java/com/baeldung/config/AppConfiguration.java

@@ -0,0 +1,19 @@
+package com.baeldung.config;
+
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.DefaultServletHandlerConfigurer;
+import org.springframework.web.servlet.config.annotation.EnableWebMvc;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
+
+@Configuration
+@EnableWebMvc
+@ComponentScan(basePackages = "com.baeldung")
+public class AppConfiguration extends WebMvcConfigurerAdapter {
+
+    @Override
+    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
+        configurer.enable();
+    }
+
+}

log-mdc/src/main/java/com/baeldung/config/AppInitializer.java

@@ -0,0 +1,29 @@
+package com.baeldung.config;
+
+import javax.servlet.ServletContext;
+import javax.servlet.ServletException;
+
+import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;
+
+public class AppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {
+
+    @Override
+    public void onStartup(ServletContext servletContext) throws ServletException {
+        super.onStartup(servletContext);
+    }
+
+    @Override
+    protected Class<?>[] getRootConfigClasses() {
+        return new Class[] { AppConfiguration.class };
+    }
+
+    @Override
+    protected Class<?>[] getServletConfigClasses() {
+        return null;
+    }
+
+    @Override
+    protected String[] getServletMappings() {
+        return new String[] { "/" };
+    }
+}

log-mdc/src/main/java/com/baeldung/ndc/Investment.java

@@ -0,0 +1,41 @@
+package com.baeldung.ndc;
+
+public class Investment {
+    private String transactionId;
+    private String owner;
+    private Long amount;
+
+    public Investment() {
+    }
+
+    public Investment(String transactionId, String owner, Long amount) {
+        this.transactionId = transactionId;
+        this.owner = owner;
+        this.amount = amount;
+    }
+
+    public String getTransactionId() {
+        return transactionId;
+    }
+
+    public void setTransactionId(String transactionId) {
+        this.transactionId = transactionId;
+    }
+
+    public String getOwner() {
+        return owner;
+    }
+
+    public void setOwner(String owner) {
+        this.owner = owner;
+    }
+
+    public Long getAmount() {
+        return amount;
+    }
+
+    public void setAmount(Long amount) {
+        this.amount = amount;
+    }
+
+}

log-mdc/src/main/java/com/baeldung/ndc/controller/JBossLoggingController.java

@@ -0,0 +1,42 @@
+package com.baeldung.ndc.controller;
+
+import org.jboss.logging.NDC;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.RestController;
+
+import com.baeldung.ndc.Investment;
+import com.baeldung.ndc.service.InvestmentService;
+
+
+@RestController
+public class JBossLoggingController {
+    @Autowired
+    @Qualifier("JBossLoggingInvestmentService")
+    private InvestmentService jbossLoggingBusinessService;
+
+    @RequestMapping(value = "/ndc/jboss-logging", method = RequestMethod.POST)
+    public ResponseEntity<Investment> postPayment(@RequestBody Investment investment) {
+        // Add transactionId and owner to NDC
+        NDC.push("tx.id=" + investment.getTransactionId());
+        NDC.push("tx.owner=" + investment.getOwner());
+
+        try {
+            jbossLoggingBusinessService.transfer(investment.getAmount());
+        } finally {
+            // take out owner from the NDC stack
+            NDC.pop();
+
+            // take out transactionId from the NDC stack
+            NDC.pop();
+
+            NDC.clear();
+        }
+        return new ResponseEntity<Investment>(investment, HttpStatus.OK);
+    }
+}

log-mdc/src/main/java/com/baeldung/ndc/controller/Log4J2Controller.java

@@ -0,0 +1,41 @@
+package com.baeldung.ndc.controller;
+
+import org.apache.logging.log4j.ThreadContext;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.RestController;
+
+import com.baeldung.ndc.Investment;
+import com.baeldung.ndc.service.InvestmentService;
+
+@RestController
+public class Log4J2Controller {
+    @Autowired
+    @Qualifier("log4j2InvestmentService")
+    private InvestmentService log4j2BusinessService;
+
+    @RequestMapping(value = "/ndc/log4j2", method = RequestMethod.POST)
+    public ResponseEntity<Investment> postPayment(@RequestBody Investment investment) {
+        // Add transactionId and owner to NDC
+        ThreadContext.push("tx.id=" + investment.getTransactionId());
+        ThreadContext.push("tx.owner=" + investment.getOwner());
+
+        try {
+            log4j2BusinessService.transfer(investment.getAmount());
+        } finally {
+            // take out owner from the NDC stack
+            ThreadContext.pop();
+
+            // take out transactionId from the NDC stack
+            ThreadContext.pop();
+
+            ThreadContext.clearAll();
+        }
+        return new ResponseEntity<Investment>(investment, HttpStatus.OK);
+    }
+}

log-mdc/src/main/java/com/baeldung/ndc/controller/Log4JController.java

@@ -0,0 +1,41 @@
+package com.baeldung.ndc.controller;
+
+import org.apache.log4j.NDC;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.RestController;
+
+import com.baeldung.ndc.Investment;
+import com.baeldung.ndc.service.InvestmentService;
+
+@RestController
+public class Log4JController {
+    @Autowired
+    @Qualifier("log4jInvestmentService")
+    private InvestmentService log4jBusinessService;
+
+    @RequestMapping(value = "/ndc/log4j", method = RequestMethod.POST)
+    public ResponseEntity<Investment> postPayment(@RequestBody Investment investment) {
+        // Add transactionId and owner to NDC
+        NDC.push("tx.id=" + investment.getTransactionId());
+        NDC.push("tx.owner=" + investment.getOwner());
+
+        try {
+            log4jBusinessService.transfer(investment.getAmount());
+        } finally {
+            // take out owner from the NDC stack
+            NDC.pop();
+
+            // take out transactionId from the NDC stack
+            NDC.pop();
+
+            NDC.remove();
+        }
+        return new ResponseEntity<Investment>(investment, HttpStatus.OK);
+    }
+}

log-mdc/src/main/java/com/baeldung/ndc/service/InvestmentService.java

@@ -0,0 +1,31 @@
+package com.baeldung.ndc.service;
+
+/**
+ * A fake investment service.
+ */
+public interface InvestmentService {
+
+    /**
+     * Sample service transferring a given amount of money.
+     * @param amount
+     * @return {@code true} when the transfer complete successfully, {@code false} otherwise.
+     */
+    default public boolean transfer(long amount) {
+        beforeTransfer(amount);
+        // exchange messages with a remote system to transfer the money
+        try {
+            // let's pause randomly to properly simulate an actual system.
+            Thread.sleep((long) (500 + Math.random() * 500));
+        } catch (InterruptedException e) {
+            // should never happen
+        }
+        // let's simulate both failing and successful transfers
+        boolean outcome = Math.random() >= 0.25;
+        afterTransfer(amount, outcome);
+        return outcome;
+    }
+
+    void beforeTransfer(long amount);
+
+    void afterTransfer(long amount, boolean outcome);
+}

log-mdc/src/main/java/com/baeldung/ndc/service/JBossLoggingInvestmentService.java

@@ -0,0 +1,21 @@
+package com.baeldung.ndc.service;
+
+import org.jboss.logging.Logger;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.stereotype.Service;
+
+@Service
+@Qualifier("JBossLoggingInvestmentService")
+public class JBossLoggingInvestmentService implements InvestmentService {
+    private static final Logger logger = Logger.getLogger(JBossLoggingInvestmentService.class);
+
+    @Override
+    public void beforeTransfer(long amount) {
+        logger.infov("Preparing to transfer {0}$.", amount);
+    }
+
+    @Override
+    public void afterTransfer(long amount, boolean outcome) {
+        logger.infov("Has transfer of {0}$ completed successfully ? {1}.", amount, outcome);
+    }
+}

log-mdc/src/main/java/com/baeldung/ndc/service/Log4J2InvestmentService.java

@@ -0,0 +1,22 @@
+package com.baeldung.ndc.service;
+
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.stereotype.Service;
+
+@Service
+@Qualifier("log4j2InvestmentService")
+public class Log4J2InvestmentService implements InvestmentService {
+    private static final Logger logger = LogManager.getLogger();
+
+    @Override
+    public void beforeTransfer(long amount) {
+        logger.info("Preparing to transfer {}$.", amount);
+    }
+
+    @Override
+    public void afterTransfer(long amount, boolean outcome) {
+        logger.info("Has transfer of {}$ completed successfully ? {}.", amount, outcome);
+    }
+}

log-mdc/src/main/java/com/baeldung/ndc/service/Log4JInvestmentService.java

@@ -0,0 +1,21 @@
+package com.baeldung.ndc.service;
+
+import org.apache.log4j.Logger;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.stereotype.Service;
+
+@Service
+@Qualifier("log4jInvestmentService")
+public class Log4JInvestmentService implements InvestmentService {
+    private Logger logger = Logger.getLogger(Log4JInvestmentService.class);
+
+    @Override
+    public void beforeTransfer(long amount) {
+        logger.info("Preparing to transfer " + amount + "$.");
+    }
+
+    @Override
+    public void afterTransfer(long amount, boolean outcome) {
+        logger.info("Has transfer of " + amount + "$ completed successfully ? " + outcome + ".");
+    }
+}

log-mdc/src/main/resources/log4j.properties

@@ -3,6 +3,10 @@ log4j.appender.consoleAppender.layout=org.apache.log4j.PatternLayout
 
 #note the %X{userName} - this is how you fetch data from Mapped Diagnostic Context (MDC)
 #log4j.appender.consoleAppender.layout.ConversionPattern=%-4r [%t] %5p %c{1} %x - %m%n
+# %x is used to fetch data from NDC. So below setting uses both MDC and NDC
 log4j.appender.consoleAppender.layout.ConversionPattern=%-4r [%t] %5p %c{1} %x - %m - tx.id=%X{transaction.id} tx.owner=%X{transaction.owner}%n 
 
-log4j.rootLogger = TRACE, consoleAppender
+# NDC only setting - %x is used to fetch data from NDC
+#log4j.appender.consoleAppender.layout.ConversionPattern=%-4r [%t] %5p %c{1} - %m - [%x]%n
+
+log4j.rootLogger = INFO, consoleAppender

log-mdc/src/main/resources/log4j2.xml

@@ -2,8 +2,15 @@
 <Configuration status="INFO">
 	<Appenders>
 		<Console name="stdout" target="SYSTEM_OUT">
+		    <!-- MDC and NDC -->
 			<PatternLayout
-				pattern="%-4r [%t] %5p %c{1} - %m - tx.id=%X{transaction.id} tx.owner=%X{transaction.owner}%n" />
+				pattern="%-4r [%t] %5p %c{1} - %m - %x - tx.id=%X{transaction.id} tx.owner=%X{transaction.owner}%n" />
+		    <!-- MDC Only -->
+			<!-- <PatternLayout
+				pattern="%-4r [%t] %5p %c{1} - %m - tx.id=%X{transaction.id} tx.owner=%X{transaction.owner}%n" />  -->
+		    <!-- NDC Only -->
+			<!-- <PatternLayout
+				pattern="%-4r [%t] %5p %c{1} - %m - %x%n" />  -->
 		</Console>
 	</Appenders>
 

log-mdc/src/test/java/com/baeldung/ndc/NDCLogTest.java

@@ -0,0 +1,61 @@
+package com.baeldung.ndc;
+
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.MediaType;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.web.WebAppConfiguration;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
+import org.springframework.web.context.WebApplicationContext;
+
+import com.baeldung.config.AppConfiguration;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+@RunWith(SpringJUnit4ClassRunner.class)
+@ContextConfiguration(classes = AppConfiguration.class)
+@WebAppConfiguration
+public class NDCLogTest {
+
+    private MockMvc mockMvc;
+
+    @Autowired
+    private WebApplicationContext webApplicationContext;
+
+    private Investment investment;
+
+    @Before
+    public void setUp() {
+        mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();
+
+        investment = new Investment();
+        investment.setTransactionId("123");
+        investment.setOwner("Mark");
+        investment.setAmount(1000L);
+    }
+
+    @Test
+    public void givenLog4jLogger_whenNDCAdded_thenResponseOkAndNDCInLog() throws Exception {
+        mockMvc.perform(post("/ndc/log4j", investment).contentType(MediaType.APPLICATION_JSON).content(new ObjectMapper().writeValueAsString(investment))).andExpect(status().is2xxSuccessful());
+
+    }
+
+    @Test
+    public void givenLog4j2Logger_whenNDCAdded_thenResponseOkAndNDCInLog() throws Exception {
+        mockMvc.perform(post("/ndc/log4j2", investment).contentType(MediaType.APPLICATION_JSON).content(new ObjectMapper().writeValueAsString(investment))).andExpect(status().is2xxSuccessful());
+
+    }
+
+    @Test
+    public void givenJBossLoggerBridge_whenNDCAdded_thenResponseOkAndNDCInLog() throws Exception {
+        mockMvc.perform(post("/ndc/jboss-logging", investment).contentType(MediaType.APPLICATION_JSON).content(new ObjectMapper().writeValueAsString(investment))).andExpect(status().is2xxSuccessful());
+
+    }
+
+}