[LOG-11301] InsightOps Java library should send data by TLS by default

Author: maquilanti-r7

pom.xml

@@ -10,18 +10,12 @@
         <disruptor.version>3.3.6</disruptor.version>
     </properties>
 
-    <parent>
-        <groupId>org.sonatype.oss</groupId>
-        <artifactId>oss-parent</artifactId>
-        <version>7</version>
-    </parent>
-
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.rapid7</groupId>
     <artifactId>r7insight_java</artifactId>
     <packaging>jar</packaging>
     <name>r7insight_java</name>
-    <version>1.1.40-SNAPSHOT</version>
+    <version>1.1.40</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>
@@ -101,20 +95,6 @@
             </activation>
             <build>
                 <plugins>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-gpg-plugin</artifactId>
-                        <version>1.1</version>
-                        <executions>
-                            <execution>
-                                <id>sign-artifacts</id>
-                                <phase>verify</phase>
-                                <goals>
-                                    <goal>sign</goal>
-                                </goals>
-                            </execution>
-                        </executions>
-                    </plugin>
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-source-plugin</artifactId>

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

@@ -33,7 +33,7 @@ public LogentriesAppender() {
     /**
      * Sets the token
      *
-     * @param token
+     * @param token Insight OPS token
      */
     public void setToken(String token) {
         this.configurationBuilder.useToken(token);
@@ -42,7 +42,7 @@ public void setToken(String token) {
     /**
      * Sets the region
      *
-     * @param region
+     * @param region region to send the log to (e.g. eu or us)
      */
     public void setRegion(String region) {
         this.configurationBuilder.inRegion(region);
@@ -60,7 +60,7 @@ public void setHttpPut(boolean httpPut) {
     /**
      * Sets the ACCOUNT KEY value for HTTP PUT
      *
-     * @param accountKey
+     * @param accountKey account key value (for http put only)
      */
     public void setKey(String accountKey) {
         this.configurationBuilder.useAccountKey(accountKey);
@@ -69,7 +69,7 @@ public void setKey(String accountKey) {
     /**
      * Sets the LOCATION value for HTTP PUT
      *
-     * @param logLocation
+     * @param logLocation location on server (for http put only)
      */
     public void setLocation(String logLocation) {
         this.configurationBuilder.httpPutLocation(logLocation);
@@ -78,7 +78,7 @@ public void setLocation(String logLocation) {
     /**
      * Sets the SSL boolean flag
      *
-     * @param ssl
+     * @param ssl true to send logs encrypted over ssl/tls
      */
     public void setSsl(boolean ssl) {
         this.configurationBuilder.useSSL(ssl);
@@ -115,7 +115,7 @@ public void setDataHubAddr(String dataHubAddr) {
     /**
      * Sets the port number on which DataHub instance waits for log messages.
      *
-     * @param dataHubPort
+     * @param dataHubPort data hub port number
      */
     public void setDataHubPort(int dataHubPort) {
         this.configurationBuilder.toServerPort(dataHubPort);
@@ -124,7 +124,7 @@ public void setDataHubPort(int dataHubPort) {
     /**
      * Determines whether to send HostName alongside with the log message
      *
-     * @param logHostName
+     * @param logHostName true to add server host name as log prefix
      */
     public void setLogHostName(boolean logHostName) {
         this.configurationBuilder.logHostNameAsPrefix(logHostName);
@@ -133,7 +133,7 @@ public void setLogHostName(boolean logHostName) {
     /**
      * Sets the HostName from the configuration
      *
-     * @param hostName
+     * @param hostName host name value
      */
     public void setHostName(String hostName) {
         this.configurationBuilder.useAsHostName(hostName);
@@ -142,7 +142,7 @@ public void setHostName(String hostName) {
     /**
      * Sets LogID parameter from the configuration, it will appear as prefix in any log line
      *
-     * @param logID
+     * @param logID log prefix
      */
     public void setLogID(String logID) {
         this.configurationBuilder.setLogIdPrefix(logID);
@@ -151,7 +151,7 @@ public void setLogID(String logID) {
     /**
      * Implements AppenderSkeleton Append method, handles time and format
      *
-     * @event event to log
+     * @param event event to log
      */
     @Override
     protected void append(LoggingEvent event) {

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

@@ -15,7 +15,7 @@
 
 /**
  * Log4J2 Appender that writes to Logentries.
- * <p/>
+ *
  * Created by josh on 11/15/14.
  */
 @Plugin(name = "Logentries", category = "Core", elementType = "appender", printObject = true)

src/main/java/com/rapid7/log4j2/package-info.java

@@ -1,5 +1,5 @@
 /**
- * Log4J2 -> Logentries integration.
+ * Log4J2 - Logentries integration.
  * <p>
  * Created by josh on 11/15/14.
  */

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

@@ -5,11 +5,9 @@
 
 /**
  * Formatter to generate Logentries-compatible stack traces.
- * <p>
  * <p>The Logentries TCP token input is delimited by a traditional newline '\n'
  * char, so multiline events like stack traces should use the unicode line
  * separator.</p>
- * <p>
  * <p>This class simplifies the coercion of logged exceptions into events that
  * can be easily viewed and searched through <a
  * href="https://logentries.com">Logentries</a>.</p>
@@ -29,7 +27,6 @@ public class ExceptionFormatter {
 
     /**
      * Returns a formatted stack trace for an exception.
-     * <p>
      * <p>This method provides a full (non-truncated) trace delimited by
      * {@link #DELIMITER}. Currently it doesn't make any use of Java 7's <a
      * href="http://docs.oracle.com/javase/tutorial/essential/exceptions/tryResourceClose.html#suppressed-exceptions">exception

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

@@ -54,7 +54,7 @@ public LogentriesAppender() {
     /**
      * Sets the token.
      *
-     * @param token
+     * @param token Insight OPS token
      */
     public void setToken(String token) {
         this.configurationBuilder.useToken(token);
@@ -63,7 +63,7 @@ public void setToken(String token) {
     /**
      * Sets the region.
      *
-     * @param region
+     * @param region region to send the log to (e.g. eu or us)
      */
     public void setRegion(String region) {
         this.configurationBuilder.inRegion(region);
@@ -82,7 +82,7 @@ public void setHttpPut(boolean httpPut) {
     /**
      * Sets the ACCOUNT KEY value for HTTP PUT.
      *
-     * @param accountKey
+     * @param accountKey account key value (for http put only)
      */
     public void setKey(String accountKey) {
         this.configurationBuilder.useAccountKey(accountKey);
@@ -91,7 +91,7 @@ public void setKey(String accountKey) {
     /**
      * Sets the LOCATION value for HTTP PUT.
      *
-     * @param logLocation
+     * @param logLocation location on server (for http put only)
      */
     public void setLocation(String logLocation) {
         this.configurationBuilder.httpPutLocation(logLocation);
@@ -100,15 +100,14 @@ public void setLocation(String logLocation) {
     /**
      * Sets the SSL boolean flag
      *
-     * @param ssl
+     * @param ssl true to send logs encrypted over ssl/tls
      */
     public void setSsl(boolean ssl) {
         this.configurationBuilder.useSSL(ssl);
     }
 
     /**
      * Sets the debug flag.
-     * <p>
      * <p>Appender in debug mode will print error messages on error console.</p>
      *
      * @param debug debug flag to set
@@ -138,7 +137,7 @@ public void setDataHubAddr(String dataHubAddr) {
     /**
      * Sets the port number on which DataHub instance waits for log messages.
      *
-     * @param dataHubPort
+     * @param dataHubPort data hub port number
      */
     public void setDataHubPort(int dataHubPort) {
         this.configurationBuilder.toServerPort(dataHubPort);
@@ -147,7 +146,7 @@ public void setDataHubPort(int dataHubPort) {
     /**
      * Determines whether to send HostName alongside with the log message
      *
-     * @param logHostName
+     * @param logHostName true to add server host name as log prefix
      */
     public void setLogHostName(boolean logHostName) {
         this.configurationBuilder.logHostNameAsPrefix(logHostName);
@@ -156,7 +155,7 @@ public void setLogHostName(boolean logHostName) {
     /**
      * Sets the HostName from the configuration
      *
-     * @param hostName
+     * @param hostName host name value
      */
     public void setHostName(String hostName) {
         this.configurationBuilder.useAsHostName(hostName);
@@ -165,16 +164,16 @@ public void setHostName(String hostName) {
     /**
      * Sets LogID parameter from the configuration
      *
-     * @param logID
+     * @param logID log prefix
      */
     public void setLogID(String logID) {
         this.configurationBuilder.setLogIdPrefix(logID);
     }
 
     /**
-     * Sets the suffixPattern to be the <pattern> field in the .xml configuration file
+     * Sets the suffixPattern to be the pattern field in the .xml configuration file
      *
-     * @param encoder
+     * @param encoder Logback Pattern Layout Encoder
      */
     public void setEncoder(PatternLayoutEncoder encoder) {
         this.suffixPattern = encoder.getPattern();
@@ -197,6 +196,7 @@ String getPrefixPattern() {
      * Returns the string value of the <b>Facility</b> option.
      * <p>
      * See {@link #setFacility} for the set of allowed values.
+     * @return facility name
      */
     public String getFacility() {
         return facilityStr;
@@ -207,9 +207,10 @@ public String getFacility() {
      * MAIL, DAEMON, AUTH, SYSLOG, LPR, NEWS, UUCP, CRON, AUTHPRIV, FTP, NTP,
      * AUDIT, ALERT, CLOCK, LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5,
      * LOCAL6, LOCAL7. Case is not important.
-     * <p>
      * <p>See {@link SyslogConstants} and RFC 3164 for more information about
      * the <b>Facility</b> option.
+     *
+     * @param facilityStr facility name
      */
     public void setFacility(String facilityStr) {
         if (facilityStr != null) {
@@ -224,6 +225,8 @@ public Layout<ILoggingEvent> getLayout() {
 
     /**
      * Sets the layout for the Appender
+     *
+     * @param layout logback layout
      */
     public void setLayout(Layout<ILoggingEvent> layout) {
         this.layout = layout;
@@ -232,7 +235,7 @@ public void setLayout(Layout<ILoggingEvent> layout) {
     /**
      * Implements AppenderSkeleton Append method, handles time and format
      *
-     * @event event to log
+     * @param event event to log
      */
     @Override
     protected void append(ILoggingEvent event) {
@@ -264,9 +267,9 @@ public Layout<ILoggingEvent> buildLayout() {
     }
 
     /**
-     * See {@link #setSuffixPattern(String).
+     * See @link #setSuffixPattern(String).
      *
-     * @return
+     * @return suffix pattern
      */
     public String getSuffixPattern() {
         return suffixPattern;
@@ -276,7 +279,7 @@ public String getSuffixPattern() {
      * The <b>suffixPattern</b> option specifies the format of the
      * non-standardized part of the message sent to the syslog server.
      *
-     * @param suffixPattern
+     * @param suffixPattern suffix pattern
      */
     public void setSuffixPattern(String suffixPattern) {
         this.suffixPattern = suffixPattern;

src/main/java/com/rapid7/net/AsyncLogger.java

@@ -18,7 +18,6 @@
  * <p>
  * a Rapid7™ service
  * <p>
- * <p>
  * VERSION: 1.2.0
  *
  * @author Viliam Holub
@@ -168,6 +167,8 @@ public final class AsyncLogger {
 
     /**
      * Initializes asynchronous logging.
+     *
+     * @param configuration logger options
      */
     public AsyncLogger(LoggerConfiguration configuration) {
 

src/test/resources/.gitignore

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<configuration>
+	<appender name="LE" class="com.rapid7.logback.LogentriesAppender">
+		<Token>0c7407d4-fd0d-4436-bb50-44f1266b4490</Token>
+		<Region>eu</Region>
+		<Ssl>true</Ssl>
+		<facility>USER</facility>
+		<dataHubAddr>localhost</dataHubAddr>
+		<dataHubPort>20000</dataHubPort>
+		<debug>true</debug>
+		<encoder>
+			<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
+		</encoder>
+	</appender>
+
+	<root level="debug">
+		<appender-ref ref="LE" />
+	</root>
+</configuration>