├── .gitignore
├── pom.xml
└── src
    ├── main
        └── resources
        │   └── logback.xml
    └── test
        └── java
            └── StructuredLoggingTests.java


/.gitignore:
--------------------------------------------------------------------------------
 1 | # Created by .ignore support plugin (hsz.mobi)
 2 | ### JetBrains template
 3 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
 4 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 5 | 
 6 | # User-specific stuff
 7 | .idea/**/workspace.xml
 8 | .idea/**/tasks.xml
 9 | .idea/**/usage.statistics.xml
10 | .idea/**/dictionaries
11 | .idea/**/shelf
12 | 
13 | # Sensitive or high-churn files
14 | .idea/**/dataSources/
15 | .idea/**/dataSources.ids
16 | .idea/**/dataSources.local.xml
17 | .idea/**/sqlDataSources.xml
18 | .idea/**/dynamic.xml
19 | .idea/**/uiDesigner.xml
20 | .idea/**/dbnavigator.xml
21 | 
22 | # Gradle
23 | .idea/**/gradle.xml
24 | .idea/**/libraries
25 | 
26 | # Gradle and Maven with auto-import
27 | # When using Gradle or Maven with auto-import, you should exclude module files,
28 | # since they will be recreated, and may cause churn.  Uncomment if using
29 | # auto-import.
30 | # .idea/modules.xml
31 | # .idea/*.iml
32 | # .idea/modules
33 | 
34 | # CMake
35 | cmake-build-*/
36 | 
37 | # Mongo Explorer plugin
38 | .idea/**/mongoSettings.xml
39 | 
40 | # File-based project format
41 | *.iws
42 | 
43 | # IntelliJ
44 | out/
45 | 
46 | # mpeltonen/sbt-idea plugin
47 | .idea_modules/
48 | 
49 | # JIRA plugin
50 | atlassian-ide-plugin.xml
51 | 
52 | # Cursive Clojure plugin
53 | .idea/replstate.xml
54 | 
55 | # Crashlytics plugin (for Android Studio and IntelliJ)
56 | com_crashlytics_export_strings.xml
57 | crashlytics.properties
58 | crashlytics-build.properties
59 | fabric.properties
60 | 
61 | # Editor-based Rest Client
62 | .idea/httpRequests
63 | ### Maven template
64 | target/
65 | pom.xml.tag
66 | pom.xml.releaseBackup
67 | pom.xml.versionsBackup
68 | pom.xml.next
69 | release.properties
70 | dependency-reduced-pom.xml
71 | buildNumber.properties
72 | .mvn/timing.properties
73 | .mvn/wrapper/maven-wrapper.jar
74 | ### Java template
75 | # Compiled class file
76 | *.class
77 | 
78 | # Log file
79 | *.log
80 | 
81 | # BlueJ files
82 | *.ctxt
83 | 
84 | # Mobile Tools for Java (J2ME)
85 | .mtj.tmp/
86 | 
87 | # Package Files #
88 | *.jar
89 | *.war
90 | *.nar
91 | *.ear
92 | *.zip
93 | *.tar.gz
94 | *.rar
95 | 
96 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
97 | hs_err_pid*
98 | 
99 | 


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <project xmlns="http://maven.apache.org/POM/4.0.0"
 3 |   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4 |   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 5 |   <modelVersion>4.0.0</modelVersion>
 6 | 
 7 |   <groupId>de.jochenchrist</groupId>
 8 |   <artifactId>structured-logging</artifactId>
 9 |   <version>1.0-SNAPSHOT</version>
10 |   <build>
11 |     <plugins>
12 |       <plugin>
13 |         <groupId>org.apache.maven.plugins</groupId>
14 |         <artifactId>maven-compiler-plugin</artifactId>
15 |         <configuration>
16 |           <source>11</source>
17 |           <target>11</target>
18 |         </configuration>
19 |       </plugin>
20 |     </plugins>
21 |   </build>
22 | 
23 |   <dependencies>
24 | 
25 |     <dependency>
26 |       <groupId>org.slf4j</groupId>
27 |       <artifactId>slf4j-api</artifactId>
28 |       <version>1.7.26</version>
29 |     </dependency>
30 |     <dependency>
31 |       <groupId>ch.qos.logback</groupId>
32 |       <artifactId>logback-classic</artifactId>
33 |       <version>1.2.3</version>
34 |     </dependency>
35 |     <dependency>
36 |       <groupId>net.logstash.logback</groupId>
37 |       <artifactId>logstash-logback-encoder</artifactId>
38 |       <version>5.2</version>
39 |     </dependency>
40 | 
41 |     <dependency>
42 |       <groupId>org.junit.jupiter</groupId>
43 |       <artifactId>junit-jupiter-engine</artifactId>
44 |       <scope>test</scope>
45 |       <version>5.3.2</version>
46 |     </dependency>
47 |   </dependencies>
48 | 
49 | 
50 | </project>


--------------------------------------------------------------------------------
/src/main/resources/logback.xml:
--------------------------------------------------------------------------------
 1 | <configuration>
 2 |   <appender name="classicConsoleAppender" class="ch.qos.logback.core.ConsoleAppender">
 3 |     <encoder>
 4 |       <pattern>%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n</pattern>
 5 |     </encoder>
 6 |   </appender>
 7 |   <appender name="jsonConsoleAppender" class="ch.qos.logback.core.ConsoleAppender">
 8 |     <encoder class="net.logstash.logback.encoder.LogstashEncoder"/>
 9 |   </appender>
10 |   <root level="INFO">
11 |     <appender-ref ref="classicConsoleAppender"/>
12 |     <appender-ref ref="jsonConsoleAppender"/>
13 |   </root>
14 | </configuration>


--------------------------------------------------------------------------------
/src/test/java/StructuredLoggingTests.java:
--------------------------------------------------------------------------------
  1 | import static net.logstash.logback.argument.StructuredArguments.keyValue;
  2 | import static net.logstash.logback.argument.StructuredArguments.kv;
  3 | import static net.logstash.logback.argument.StructuredArguments.v;
  4 | import static net.logstash.logback.argument.StructuredArguments.value;
  5 | 
  6 | import org.junit.jupiter.api.Test;
  7 | import org.slf4j.Logger;
  8 | import org.slf4j.LoggerFactory;
  9 | import org.slf4j.MDC;
 10 | 
 11 | class StructuredLoggingTests {
 12 | 
 13 |   private static final Logger log = LoggerFactory.getLogger("MyApplication");
 14 | 
 15 |   @Test
 16 |   void simpleLog() {
 17 |     log.info("Order {} saved", 123);
 18 |   }
 19 | 
 20 |   @Test
 21 |   void simpleLog2() {
 22 |     log.info("Order saved orderId", 123);
 23 |   }
 24 | 
 25 |   @Test
 26 |   void logValue() {
 27 |     String orderId = "123";
 28 |     log.info("Order {} saved", value("orderId", orderId));
 29 |   }
 30 | 
 31 |   @Test
 32 |   void logMdc() {
 33 |     String orderId = "123";
 34 |     try (var ignored = MDC.putCloseable("orderId", orderId)) {
 35 |       log.info("Order saved");
 36 |     }
 37 |   }
 38 | 
 39 |   @Test
 40 |   void logMdc2() {
 41 |     String orderId = "123";
 42 |     MDC.put("orderId", orderId);
 43 |     log.info("Order saved");
 44 |     MDC.remove("orderId");
 45 |   }
 46 | 
 47 |   @Test
 48 |   void logValue2() {
 49 |     String orderId = "123";
 50 |     log.info("Order saved {}", v("orderId", orderId));
 51 |   }
 52 | 
 53 |   @Test
 54 |   void logValue3() {
 55 |     String oldStatus = "NEW";
 56 |     String newStatus = "READY";
 57 |     log.info("Status changed {}->{}.", v("oldStatus", oldStatus), v("newStatus", newStatus));
 58 |   }
 59 | 
 60 |   @Test
 61 |   void logKeyValue() {
 62 |     String orderId = "123";
 63 |     log.info("Order saved {}", keyValue("orderId", orderId));
 64 |   }
 65 | 
 66 |   @Test
 67 |   void logKeyValue2() {
 68 |     String orderId = "123";
 69 |     String status = "NEW";
 70 |     log.info("Order saved", kv("orderId", orderId), kv("status", status));
 71 |   }
 72 | 
 73 |   @Test
 74 |   void logObject() {
 75 |     Order order = new Order("123", "NEW", null);
 76 |     log.info("Order saved", kv("order", order));
 77 |   }
 78 | 
 79 |   static class Order {
 80 |     String orderId;
 81 |     String status;
 82 |     String canceled;
 83 | 
 84 |     Order(String orderId, String status, String canceled) {
 85 |       this.orderId = orderId;
 86 |       this.status = status;
 87 |       this.canceled = canceled;
 88 |     }
 89 | 
 90 |     public String getOrderId() {
 91 |       return orderId;
 92 |     }
 93 | 
 94 |     public String getStatus() {
 95 |       return status;
 96 |     }
 97 | 
 98 |     public String getCanceled() {
 99 |       return canceled;
100 |     }
101 |   }
102 | }
103 | 


--------------------------------------------------------------------------------