architecture revamp: improved performance, nonblocking queue... (#94)

* [sender] use concurrent linked queue - non-blocking - to message enqueueing

* [tests] fix integration testing

* comment

* [sender] sleep less

* [sender] decrement when taking message from queue

* [test] add max throughput performance test

* [travis] actually do run tests

* [test] fix test teardown

* sender: we should only need to get the address once

* parametrize test workers

* Adding buffer pool and multi-worker sender

* [buffer] fixes

* [test] max_perf: default q-size 1024

* improve interruption handling behavior + collateral

* [client] adding more constructors for woker configurability

* [test] make max perf test parametric

* [maven] add surefire plugin + heap args

* [test] make max performance test less memory intensive + remove unbounded queue test

* [maven] bump surefire

* abstract class and blocking+nonblocking processor

* better construction + class abstractions

* [test] fix them - less is more

* [processor] multi-worker support

* blocking processor: remove unused imports

* [test] we can reuse port, support more scenarios

* [maven] add checkstyle

* [maven] add checkstyle

* [checkstyle] fix all checkstyle offenses

* [javadoc] fix issues with javadoc

* [mvn] silence illegal access warning; not real.

* [travis] attempt to checkstyle with a different version on Java7

* removing unused imports.

* [mvn] support up to Java 13.0.2.

* [circleci] add openjdk13 to test matrix

* [circleci] no checkstyle on java7 + remove travis (#100)

* [circleci] no checkstyle on java7

* [travis] get off travis

Author: truthbk

.circleci/config.yml

@@ -18,24 +18,30 @@ default_steps: &default_steps
           - ~/.m2
         key: v1-dependencies-{{ checksum "pom.xml" }}
     - run: |
-        mvn clean install -Dgpg.skip
+        mvn clean install -Dgpg.skip $MVN_EXTRA_OPTS
 
 jobs:
   openjdk7:
     docker:
-        - image: jfullaondo/openjdk:7
+      - image: jfullaondo/openjdk:7
+    environment:
+      MVN_EXTRA_OPTS: -Dcheckstyle.version=2.15 -Dcheckstyle.skip
     <<: *default_steps
   openjdk8:
     docker:
-        - image: circleci/openjdk:8u242
+      - image: circleci/openjdk:8u242
     <<: *default_steps
   openjdk9:
     docker:
-        - image: circleci/openjdk:9.0.4-12
+      - image: circleci/openjdk:9.0.4-12
     <<: *default_steps
   openjdk11:
     docker:
-        - image: circleci/openjdk:11.0.2
+      - image: circleci/openjdk:11.0.2
+    <<: *default_steps
+  openjdk13:
+    docker:
+      - image: circleci/openjdk:13.0.2-buster
     <<: *default_steps
 
 workflows:
@@ -46,3 +52,4 @@ workflows:
       - openjdk8
       - openjdk9
       - openjdk11
+      - openjdk13

.travis.yml

@@ -12,6 +12,14 @@
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <java.version>1.6</java.version>
+    <!-- Note: using project checkstyle with AOSP style
+    find the default google java checkstyle config here -
+	<checkstyle.config.location>google_checks.xml</checkstyle.config.location>
+     -->
+	<checkstyle.config.location>style.xml</checkstyle.config.location>
+	<checkstyle.consoleOutput>true</checkstyle.consoleOutput>
+    <jdk.module.illegalAccess>deny</jdk.module.illegalAccess>
+    <checkstyle.version>3.1.0</checkstyle.version>
   </properties>
 
   <licenses>
@@ -92,6 +100,11 @@
 
   <build>
     <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <version>2.19</version>
+      </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-enforcer-plugin</artifactId>
@@ -105,7 +118,7 @@
             <configuration>
               <rules>
                 <requireJavaVersion>
-                  <version>[1.7.0-0,1.9.0-0),[9.0.0,11.0.5]</version>
+                  <version>[1.7.0-0,1.9.0-0),[9.0.0,13.0.2]</version>
                 </requireJavaVersion>
               </rules>
             </configuration>
@@ -186,7 +199,50 @@
           <autoReleaseAfterClose>true</autoReleaseAfterClose>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-checkstyle-plugin</artifactId>
+        <version>${checkstyle.version}</version>
+        <executions>
+          <execution>
+            <id>checkstyle</id>
+            <phase>verify</phase>
+            <configuration>
+              <encoding>UTF-8</encoding>
+              <consoleOutput>true</consoleOutput>
+              <failsOnError>true</failsOnError>
+              <failOnViolation>true</failOnViolation>
+              <violationSeverity>warning</violationSeverity>
+              <linkXRef>false</linkXRef>
+            </configuration>
+            <goals>
+              <goal>check</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 
+  <reporting>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-checkstyle-plugin</artifactId>
+        <version>${checkstyle.version}</version>
+        <reportSets>
+          <reportSet>
+            <reports>
+              <report>checkstyle</report>
+            </reports>
+          </reportSet>
+        </reportSets>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-jxr-plugin</artifactId>
+        <version>3.0.0</version>
+      </plugin>
+    </plugins>
+  </reporting>
 </project>

pom.xml

@@ -0,0 +1,37 @@
+package com.timgroup.statsd;
+
+import java.nio.ByteBuffer;
+
+import java.util.concurrent.ArrayBlockingQueue;
+import java.util.concurrent.BlockingQueue;
+
+public class BufferPool {
+    private final BlockingQueue<ByteBuffer> pool;
+    private final int size;
+
+
+    BufferPool(final int poolSize, int bufferSize, final boolean direct) throws InterruptedException {
+
+        size = poolSize;
+        pool = new ArrayBlockingQueue<ByteBuffer>(poolSize);
+        for (int i = 0; i < size ; i++) {
+            if (direct) {
+                pool.put(ByteBuffer.allocateDirect(bufferSize));
+            } else {
+                pool.put(ByteBuffer.allocate(bufferSize));
+            }
+        }
+    }
+
+    ByteBuffer borrow() throws InterruptedException {
+        return pool.take();
+    }
+
+    void put(ByteBuffer buffer) throws InterruptedException {
+        pool.put(buffer);
+    }
+
+    int available() {
+        return pool.size();
+    }
+}

src/main/java/com/timgroup/statsd/BufferPool.java

@@ -3,7 +3,7 @@
 import java.util.Date;
 
 /**
- * An event to send
+ * An event to send.
  * @see <a href="http://docs.datadoghq.com/guides/dogstatsd/#events">http://docs.datadoghq.com/guides/dogstatsd/#events</a>
  */
 public class Event {
@@ -25,6 +25,7 @@ public String getText() {
     }
 
     /**
+     * Get number of milliseconds since epoch started.
      * @return -1 if not set
      */
     public long getMillisSinceEpoch() {
@@ -65,11 +66,17 @@ public enum AlertType {
         ERROR, WARNING, INFO, SUCCESS
     }
 
-    @SuppressWarnings({"AccessingNonPublicFieldOfAnotherObject", "PrivateMemberAccessBetweenOuterAndInnerClass", "ParameterHidesMemberVariable"})
+    @SuppressWarnings({"AccessingNonPublicFieldOfAnotherObject",
+            "PrivateMemberAccessBetweenOuterAndInnerClass", "ParameterHidesMemberVariable"})
     public static class Builder {
         private final Event event = new Event();
+
         private Builder() {}
 
+        /**
+         * Build factory method for the event.
+         * @return Event built following specified options.
+         */
         public Event build() {
             if ((event.title == null) || event.title.isEmpty()) {
                 throw new IllegalStateException("event title must be set");
@@ -81,62 +88,76 @@ public Event build() {
         }
 
         /**
+         * Title for the event.
          * @param title
          *     Event title ; mandatory
+         * @return Builder object being used.
          */
         public Builder withTitle(final String title) {
             event.title = title;
             return this;
         }
 
         /**
+         * Text for the event.
          * @param text
          *     Event text ; supports line breaks ; mandatory
+         * @return Builder object being used.
          */
         public Builder withText(final String text) {
             event.text = text;
             return this;
         }
 
         /**
+         * Date for the event.
          * @param date
          *     Assign a timestamp to the event ; Default: none (Default is the current Unix epoch timestamp when not sent)
+         * @return Builder object being used.
          */
         public Builder withDate(final Date date) {
             event.millisSinceEpoch = date.getTime();
             return this;
         }
 
         /**
+         * Date for the event.
          * @param millisSinceEpoch
          *     Assign a timestamp to the event ; Default: none (Default is the current Unix epoch timestamp when not sent)
+         * @return Builder object being used.
          */
         public Builder withDate(final long millisSinceEpoch) {
             event.millisSinceEpoch = millisSinceEpoch;
             return this;
         }
 
         /**
+         * Source hostname for the event.
          * @param hostname
          *     Assign a hostname to the event ; Default: none
+         * @return Builder object being used.
          */
         public Builder withHostname(final String hostname) {
             event.hostname = hostname;
             return this;
         }
 
         /**
+         * Aggregation key for the event.
          * @param aggregationKey
          *     Assign an aggregation key to the event, to group it with some others ; Default: none
+         * @return Builder object being used.
          */
         public Builder withAggregationKey(final String aggregationKey) {
             event.aggregationKey = aggregationKey;
             return this;
         }
 
         /**
+         * Priority for the event.
          * @param priority
          *     Can be "normal" or "low" ; Default: "normal"
+         * @return Builder object being used.
          */
         public Builder withPriority(final Priority priority) {
             //noinspection StringToUpperCaseOrToLowerCaseWithoutLocale
@@ -145,17 +166,21 @@ public Builder withPriority(final Priority priority) {
         }
 
         /**
+         * Source Type name for the event.
          * @param sourceTypeName
          *     Assign a source type to the event ; Default: none
+         * @return Builder object being used.
          */
         public Builder withSourceTypeName(final String sourceTypeName) {
             event.sourceTypeName = sourceTypeName;
             return this;
         }
 
         /**
+         * Alert type for the event.
          * @param alertType
          *     Can be "error", "warning", "info" or "success" ; Default: "info"
+         * @return Builder object being used.
          */
         public Builder withAlertType(final AlertType alertType) {
             //noinspection StringToUpperCaseOrToLowerCaseWithoutLocale

src/main/java/com/timgroup/statsd/Event.java

@@ -1,7 +1,7 @@
 package com.timgroup.statsd;
 
 /**
- * Signals that we've been passed a message that's invalid and won't be sent
+ * Signals that we've been passed a message that's invalid and won't be sent.
  *
  * @author Taylor Schilling
  */
@@ -11,7 +11,7 @@ public class InvalidMessageException extends RuntimeException {
     private final String invalidMessage;
 
     /**
-     * Creates an InvalidMessageException with a specified detail message and the invalid message itself
+     * Creates an InvalidMessageException with a specified detail message and the invalid message itself.
      *
      * @param detailMessage a message that details why the invalid message is considered so
      * @param invalidMessage the message deemed invalid