Added additional JSON fields and included fat jar build with all the required dependencies.

Signed-off-by: Nick Wemekamp <[email protected]>

Author: Nick Wemekamp

README.md

@@ -96,7 +96,7 @@ The `weblogic-logging-exporter.jar` will be available under the `target` directo
 
 ## Installation
 
-This section outlines the steps that are required to add the Weblogic Logging Exporter to Weblogic Server.
+This section outlines the steps that are required to add the WebLogic Logging Exporter to WebLogic Server.
 
 1. Download or build the WebLogic Logging Exporter as described above.
 
@@ -119,17 +119,7 @@ This section outlines the steps that are required to add the Weblogic Logging Ex
     </startup-class>
     ```
 
-1. Add `weblogic-logging-exporter.jar` and `snakeyaml-1.27.jar` to your classpath.
-
-   This project requires `snakeyaml` to parse the YAML configuration file.  If you built the project locally,
-   you can find this JAR file in your local maven repository at `~/.m2/repository/org/yaml/snakeyaml/1.27/snakeyaml-1.27.jar`.
-   Otherwise, you can download it from [Maven Central](https://search.maven.org/artifact/org.yaml/snakeyaml/1.27/bundle).
-
-   If you want to write the JSON logs to a file instead of sending it elasticsearch directly you will also need these jars:
-   - ecs-logging-core-1.1.0.jar (used for JSON logging, https://mvnrepository.com/artifact/co.elastic.logging/ecs-logging-core)
-   - jul-ecs-formatter-1.1.0.jar (used for JSON logging, https://mvnrepository.com/artifact/co.elastic.logging/jul-ecs-formatter/1.1.0)
-   - slf4j-api-1.7.32.jar (optional and is used for MDC, https://mvnrepository.com/artifact/org.slf4j/slf4j-api)
-   - slf4j-jdk14-1.7.32.jar (optional and is used for MDC, https://mvnrepository.com/artifact/org.slf4j/slf4j-jdk14)
+1. Add `weblogic-logging-exporter.jar` to your classpath.
 
    Place the file(s) in a suitable location, e.g. your domain directory.
 
@@ -138,7 +128,7 @@ This section outlines the steps that are required to add the Weblogic Logging Ex
    directory is `/u01/base_domain`):
 
    ```
-   export CLASSPATH="/u01/base_domain/weblogic-logging-exporter.jar:/u01/base_domain/snakeyaml-1.27.jar:$CLASSPATH"
+   export CLASSPATH="/u01/base_domain/weblogic-logging-exporter.jar:$CLASSPATH"
    ```
 
 1. Create a configuration file for the WebLogic Logging Exporter.
@@ -170,7 +160,7 @@ This section outlines the steps that are required to add the Weblogic Logging Ex
    `WEBLOGIC_LOGGING_EXPORTER_CONFIG_FILE` to point to the location of the file.
 
    If you want to write the JSON logs to a file instead of sending it elasticsearch directly use the following configuration
-   [file](samples/WeblogicFileLoggingExporter.yaml) and adjust it to your needs. Make sure to rename it to WebLogicLoggingExporter.yaml.
+   [file](samples/WebLogicFileLoggingExporter.yaml) and adjust it to your needs. Make sure to rename it to WebLogicLoggingExporter.yaml.
 
 6. Restart the servers to activate the changes.  After restarting the servers, they will load the WebLogic
    Logging Exporter and start sending their logs to the specified Elasticsearch instance.  You can then

pom.xml

@@ -63,7 +63,6 @@
             </plugin>
             <!-- for junit 5 -->
             <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
                 <version>2.22.2</version>
                 <configuration>
@@ -88,7 +87,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-failsafe-plugin</artifactId>
-                <version>2.22.1</version>
+                <version>2.22.2</version>
             </plugin>
             <!-- end -->
             <plugin>
@@ -111,6 +110,24 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-assembly-plugin</artifactId>
+                <version>3.3.0</version>
+                <executions>
+                    <execution>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>single</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <descriptorRefs>
+                        <descriptorRef>jar-with-dependencies</descriptorRef>
+                    </descriptorRefs>
+                </configuration>
+            </plugin>
         </plugins>
     </build>
 
@@ -195,15 +212,21 @@
         <dependency>
             <groupId>co.elastic.logging</groupId>
             <artifactId>jul-ecs-formatter</artifactId>
-            <version>1.1.0</version>
+            <version>1.2.0</version>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-jdk14</artifactId>
+            <version>1.7.32</version>
         </dependency>
         <dependency>
             <groupId>org.antlr</groupId>
             <artifactId>antlr-complete</artifactId>
             <version>3.5.2</version>
+            <!-- we need it in unit tests but the weblogic runtime provides it at run time -->
+            <scope>test</scope>
         </dependency>
     </dependencies>
-
     <reporting>
         <plugins>
             <plugin>

samples/WeblogicFileLoggingExporter.yaml renamed to samples/WebLogicFileLoggingExporter.yaml

@@ -8,7 +8,6 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
-import co.elastic.logging.jul.EcsFormatter;
 import weblogic.logging.LoggingHelper;
 import weblogic.logging.ServerLoggingHandler;
 import weblogic.logging.exporter.config.Config;
@@ -18,7 +17,7 @@ public class Startup {
   private static final String DEFAULT_CONFIG_FILE = "config/WebLogicLoggingExporter.yaml";
 
   public static void main(String[] argv) {
-    System.out.println("======================= Weblogic Logging Exporter Startup class called");
+    System.out.println("======================= WebLogic Logging Exporter Startup class called");
     try {
       Logger logger = LoggingHelper.getServerLogger();
 
@@ -30,15 +29,15 @@ public static void main(String[] argv) {
       */
 
       String fileName =
-          System.getProperty(
-              "WEBLOGIC_LOGGING_EXPORTER_CONFIG_FILE",
-              System.getenv("WEBLOGIC_LOGGING_EXPORTER_CONFIG_FILE"));
+              System.getProperty(
+                      "WEBLOGIC_LOGGING_EXPORTER_CONFIG_FILE",
+                      System.getenv("WEBLOGIC_LOGGING_EXPORTER_CONFIG_FILE"));
       System.out.println(
-          "JavaProperty/EnvVariable WEBLOGIC_LOGGING_EXPORTER_CONFIG_FILE:" + fileName);
+              "JavaProperty/EnvVariable WEBLOGIC_LOGGING_EXPORTER_CONFIG_FILE:" + fileName);
       if (fileName == null || fileName.isEmpty()) {
         System.out.println(
-            "Env variable WEBLOGIC_LOGGING_EXPORTER_CONFIG_FILE is not set. Defaulting to:"
-                + DEFAULT_CONFIG_FILE);
+                "Env variable WEBLOGIC_LOGGING_EXPORTER_CONFIG_FILE is not set. Defaulting to:"
+                        + DEFAULT_CONFIG_FILE);
         fileName = DEFAULT_CONFIG_FILE;
       }
       File file = new File(fileName);
@@ -57,14 +56,14 @@ public static void main(String[] argv) {
         // Register a file handler using the provided config
         FileHandler fh = new FileHandler(config.getOutputFile(), config.getMaxFileSize(), config.getGetMaxRollbackFiles(), config.getAppendToFile());
         fh.setLevel(Level.parse(config.getFileLoggingLogLevel()));
-        fh.setFormatter(new EcsFormatter());
+        fh.setFormatter(new WebLogicLogFormatter(config.getDomainUID()));
         logger.addHandler(fh);
-       } else {
+      } else {
         System.out.println("WebLogic Elasticsearch Logging Exporter is disabled");
       }
-      // also catch errors so that Weblogic does not crash when a required library was not placed in the classpath correctly.
+      // also catch errors so that WebLogic does not crash when a required library was not placed in the classpath correctly.
     } catch (Error | Exception e) {
-      System.out.println("======================= Something went wrong, the Weblogic Logging Exporter is not activated");
+      System.out.println("======================= Something went wrong, the WebLogic Logging Exporter is not activated");
       e.printStackTrace();
     }
   }

src/main/java/weblogic/logging/exporter/Startup.java

@@ -0,0 +1,55 @@
+package weblogic.logging.exporter;
+
+import co.elastic.logging.jul.EcsFormatter;
+import org.slf4j.MDC;
+import weblogic.logging.WLLogRecord;
+
+import java.util.logging.LogRecord;
+
+public class WebLogicLogFormatter extends EcsFormatter {
+    public static final String FIELDS_MESSAGE_ID = "fields.messageID";
+    public static final String FIELDS_SERVER_NAME = "fields.serverName";
+    public static final String FIELDS_USER_ID = "fields.userId";
+    public static final String FIELDS_SUB_SYSTEM = "fields.subSystem";
+    public static final String FIELDS_MACHINE_NAME = "fields.machineName";
+    public static final String FIELDS_TRANSACTION_ID = "fields.transactionId";
+    public static final String FIELDS_DIAGNOSTIC_CONTEXT_ID = "fields.diagnosticContextId";
+    public static final String FIELDS_SEQUENCE_NUMBER = "fields.sequenceNumber";
+    public static final String FIELDS_DOMAIN_UID = "fields.domainUID";
+
+    private final String domainUID;
+
+    public WebLogicLogFormatter(String domainUID) {
+        this.domainUID = domainUID;
+    }
+
+    @Override
+    public String format(final LogRecord record) {
+        WLLogRecord wlLogRecord = (WLLogRecord) record;
+
+        MDC.put(FIELDS_MESSAGE_ID, wlLogRecord.getId());
+        MDC.put(FIELDS_SERVER_NAME, wlLogRecord.getServerName());
+        MDC.put(FIELDS_USER_ID, wlLogRecord.getUserId());
+        MDC.put(FIELDS_SUB_SYSTEM, wlLogRecord.getSubsystem());
+        MDC.put(FIELDS_MACHINE_NAME, wlLogRecord.getMachineName());
+        MDC.put(FIELDS_TRANSACTION_ID, wlLogRecord.getTransactionId());
+        MDC.put(FIELDS_DIAGNOSTIC_CONTEXT_ID, wlLogRecord.getDiagnosticContextId());
+        MDC.put(FIELDS_SEQUENCE_NUMBER, String.valueOf(wlLogRecord.getSequenceNumber()));
+        MDC.put(FIELDS_DOMAIN_UID, domainUID);
+
+        String result = super.format(wlLogRecord);
+
+        // Can't clear the whole MDC HashMap as there might be other records in there.
+        MDC.remove(FIELDS_MESSAGE_ID);
+        MDC.remove(FIELDS_SERVER_NAME);
+        MDC.remove(FIELDS_USER_ID);
+        MDC.remove(FIELDS_SUB_SYSTEM);
+        MDC.remove(FIELDS_MACHINE_NAME);
+        MDC.remove(FIELDS_TRANSACTION_ID);
+        MDC.remove(FIELDS_DIAGNOSTIC_CONTEXT_ID);
+        MDC.remove(FIELDS_SEQUENCE_NUMBER);
+        MDC.remove(FIELDS_DOMAIN_UID);
+
+        return result;
+    }
+}