Add logback encoder support and use UTF-8 encoding explicitly (#11)

* Add logback encoder support and use UTF-8 encoding explicitly

* Reformat code using spaces instead of tabs

* Bump patch version

* Using Charset constructor in order to avoid encoding check

* Fix generics styling

Co-Authored-By: James Colgan <30832432+jcolgan-r7@users.noreply.github.com>

Author: 2 people

pom.xml

@@ -8,14 +8,15 @@
         <jackson.version>2.10.1</jackson.version>
         <log4j.version>2.7</log4j.version>
         <disruptor.version>3.3.6</disruptor.version>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
 
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.rapid7</groupId>
     <artifactId>r7insight_java</artifactId>
     <packaging>jar</packaging>
     <name>r7insight_java</name>
-    <version>1.1.40</version>
+    <version>1.1.41</version>
     <description>Contains logback, log4j, and log4j2 appenders that will send log data to Logentries</description>
     <url>https://github.com/rapid7/r7insight_java</url>
     <licenses>
@@ -45,6 +46,7 @@
                 <configuration>
                     <source>1.8</source>
                     <target>1.8</target>
+                    <encoding>${project.build.sourceEncoding}</encoding>
                 </configuration>
             </plugin>
             <plugin>
@@ -163,7 +165,7 @@
         <dependency>
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-classic</artifactId>
-            <version>1.0.11</version>
+            <version>1.2.3</version>
             <optional>true</optional>
         </dependency>
         <dependency>

src/main/java/com/rapid7/logback/LogentriesAppender.java

@@ -1,15 +1,18 @@
 package com.rapid7.logback;
 
 import ch.qos.logback.classic.PatternLayout;
-import ch.qos.logback.classic.encoder.PatternLayoutEncoder;
 import ch.qos.logback.classic.pattern.SyslogStartConverter;
 import ch.qos.logback.classic.spi.ILoggingEvent;
 import ch.qos.logback.core.AppenderBase;
 import ch.qos.logback.core.Layout;
+import ch.qos.logback.core.encoder.Encoder;
+import ch.qos.logback.core.encoder.LayoutWrappingEncoder;
 import ch.qos.logback.core.net.SyslogConstants;
 import com.rapid7.net.AsyncLogger;
 import com.rapid7.net.LoggerConfiguration;
 
+import static java.nio.charset.StandardCharsets.UTF_8;
+
 /**
  * Logentries appender for logback.
  *
@@ -33,6 +36,8 @@ public class LogentriesAppender extends AppenderBase<ILoggingEvent> {
      * Layout
      */
     private Layout<ILoggingEvent> layout;
+
+    private Encoder<ILoggingEvent> encoder;
     /**
      * Facility String
      */
@@ -171,18 +176,22 @@ public void setLogID(String logID) {
     }
 
     /**
-     * Sets the suffixPattern to be the pattern field in the .xml configuration file
+     * Sets the encoder for this appender
      *
-     * @param encoder Logback Pattern Layout Encoder
+     * @param encoder Logback Encoder
      */
-    public void setEncoder(PatternLayoutEncoder encoder) {
-        this.suffixPattern = encoder.getPattern();
+    public void setEncoder(Encoder<ILoggingEvent> encoder) {
+        this.encoder = encoder;
     }
 
     @Override
     public void start() {
-        if (layout == null) {
-            layout = buildLayout();
+        if (encoder == null) {
+            layout = layout == null ? buildLayout() : layout;
+            LayoutWrappingEncoder<ILoggingEvent> lwe = new LayoutWrappingEncoder<>();
+            lwe.setLayout(buildLayout());
+            lwe.setContext(getContext());
+            encoder = lwe;
         }
         this.iopsAsync = new AsyncLogger(configurationBuilder.build());
         super.start();
@@ -240,7 +249,10 @@ public void setLayout(Layout<ILoggingEvent> layout) {
     @Override
     protected void append(ILoggingEvent event) {
         // Render the event according to layout
-        String formattedEvent = layout.doLayout(event);
+        byte[] encodedEvent = encoder.encode(event);
+        String formattedEvent;
+        formattedEvent = new String(encodedEvent, UTF_8);
+
         // Prepare to be queued
         this.iopsAsync.addLineToQueue(formattedEvent);
     }

src/test/java/com/rapid7/logback/LogentriesAppenderTest.java

@@ -1,5 +1,7 @@
 package com.rapid7.logback;
 
+import ch.qos.logback.classic.LoggerContext;
+import ch.qos.logback.core.Context;
 import com.rapid7.util.SocketChannelReceiver;
 import org.junit.Test;
 import org.slf4j.Logger;
@@ -18,6 +20,8 @@ public class LogentriesAppenderTest {
     private static final boolean debug = true;
     private static final String hostname = "server1";
     private static final String logId = "LogId";
+    private static final String facility = "kern";
+    private static final Context context = new LoggerContext();
     private static final int port = 1000;
 
     private static final String EMPTY_PREFIX = "";
@@ -37,6 +41,8 @@ public void setterTests() {
         le.setHostName(hostname);
         le.setLogHostName(true);
         le.setLogID(logId);
+        le.setContext(context);
+        le.setFacility(facility);
         le.start();
         assertEquals(le.iopsAsync.getToken(), token);
         assertEquals(le.iopsAsync.getRegion(), region);
@@ -70,5 +76,4 @@ public void testCreateAppenderAndLogMessage() throws Exception {
         }
     }
 
-
 }

src/test/java/com/rapid7/logback/LogentriesAppenderTest.java~

@@ -15,6 +15,8 @@
 import java.util.concurrent.BlockingQueue;
 import java.util.concurrent.TimeUnit;
 
+import static java.nio.charset.StandardCharsets.UTF_8;
+
 /**
  * Stub of InsightOPS server
  */
@@ -105,7 +107,6 @@ private SSLContext initSSlContext() throws Exception {
         return sslContext;
     }
 
-
     private synchronized void waitUntilReady() throws InterruptedException {
         if (!isReady) {
             wait(5000);
@@ -119,7 +120,7 @@ private void listenForMessages(Socket socket) throws IOException {
             if (messageLength == -1) {
                 continue;
             }
-            String[] messages = new String(Arrays.copyOf(buffer, messageLength)).split("\\r?\\n");
+            String[] messages = new String(Arrays.copyOf(buffer, messageLength), UTF_8).split("\\r?\\n");
             Collections.addAll(messagesReceived, messages);
         }
     }