Version 2.4.0

Author: anthonygauthier

src/main/java/io/github/delirius325/jmeter/backendlistener/elasticsearch/ElasticSearchMetric.java

@@ -15,7 +15,7 @@
 import java.util.*;
 
 public class ElasticSearchMetric {
-    private static final Logger logger = LoggerFactory.getLogger(ElasticsearchBackendClient.class);
+    private static final Logger logger = LoggerFactory.getLogger(ElasticSearchMetric.class);
 
     private SampleResult sampleResult;
     private String esTestMode;
@@ -25,8 +25,8 @@ public class ElasticSearchMetric {
 
     public ElasticSearchMetric(SampleResult sr, String testMode, String timeStamp, int buildNumber) {
         this.sampleResult = sr;
-        this.esTestMode = testMode;
-        this.esTimestamp = timeStamp;
+        this.esTestMode = testMode.trim();
+        this.esTimestamp = timeStamp.trim();
         this.ciBuildNumber = buildNumber;
         this.json = new HashMap<>();
     }
@@ -63,17 +63,17 @@ public Map<String, Object> getMetric(BackendListenerContext context) throws Exce
         this.json.put("InjectorHostname",  InetAddress.getLocalHost().getHostName());
 
         // Add the details according to the mode that is set
-        if(this.esTestMode == "debug" || this.esTestMode == "error") {
-            addDetails();
-        } else if (this.esTestMode == "info") {
-            if(!this.sampleResult.isSuccessful()) {
+        switch(this.esTestMode) {
+            case "debug":
                 addDetails();
-            }
-        } else if (this.esTestMode != "quiet") {
-            logger.warn("The parameter \"es.test.mode\" isn't set properly. Three modes are allowed: debug ,info, and quiet.");
-            logger.warn(" -- \"debug\": sends request and response details to ElasticSearch. Info only sends the details if the response has an error.");
-            logger.warn(" -- \"info\": should be used in production");
-            logger.warn(" -- \"quiet\": should be used if you don't care to have the details.");
+                break;
+            case "error":
+                addDetails();
+                break;
+            case "info":
+                if(!this.sampleResult.isSuccessful())
+                    addDetails();
+                break;
         }
 
         addAssertions();

src/main/java/io/github/delirius325/jmeter/backendlistener/elasticsearch/ElasticSearchMetricSender.java

@@ -4,7 +4,6 @@
 import org.apache.http.HttpStatus;
 import org.apache.http.entity.ContentType;
 import org.apache.http.nio.entity.NStringEntity;
-import org.apache.jmeter.visualizers.backend.BackendListenerContext;
 import org.elasticsearch.client.Response;
 import org.elasticsearch.client.RestClient;
 import org.slf4j.Logger;
@@ -15,7 +14,7 @@
 import java.util.*;
 
 public class ElasticSearchMetricSender {
-    private static final Logger logger = LoggerFactory.getLogger(ElasticsearchBackendClient.class);
+    private static final Logger logger = LoggerFactory.getLogger(ElasticSearchMetricSender.class);
 
     private RestClient client;
     private String esIndex;
@@ -34,12 +33,14 @@ public ElasticSearchMetricSender(RestClient cli, String index) {
     public int getListSize() { return this.metricList.size(); }
 
     /**
-     * This method closes the REST client and clears the ElasticSearch documents list
+     * This method clears the ElasticSearch documents list
      */
-    public void closeAndClear() throws IOException {
-        this.client.close();
-        this.metricList.clear();
-    }
+    public void closeConnection() throws IOException { this.client.close(); }
+
+    /**
+     * This method closes the REST client
+     */
+    public void clearList() { this.metricList.clear(); }
 
     /**
      * This method adds a metric to the list (metricList).
@@ -62,9 +63,8 @@ public void createIndex() {
     /**
      * This method sends the ElasticSearch documents for each document present in the list (metricList).
      * All is being sent through the low-level ElasticSearch REST Client.
-     * @throws IOException
      */
-    public void sendRequest() throws IOException {
+    public void sendRequest() {
         String actionMetaData = String.format("{ \"index\" : { \"_index\" : \"%s\", \"_type\" : \"%s\" } }%n", this.esIndex, "SampleResult");
 
         StringBuilder bulkRequestBody = new StringBuilder();

src/main/java/io/github/delirius325/jmeter/backendlistener/elasticsearch/ElasticsearchBackendClient.java

@@ -11,8 +11,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.util.LinkedList;
-import java.util.List;
+import java.util.*;
 
 public class ElasticsearchBackendClient extends AbstractBackendListenerClient {
     private static final String BUILD_NUMBER        = "BuildNumber";
@@ -30,6 +29,7 @@ public class ElasticsearchBackendClient extends AbstractBackendListenerClient {
     private static final Logger logger = LoggerFactory.getLogger(ElasticsearchBackendClient.class);
 
     private ElasticSearchMetricSender sender;
+    private Set<String> modes;
     private List<String> filters;
     private RestClient client;
     private int buildNumber;
@@ -56,6 +56,7 @@ public Arguments getDefaultParameters() {
     public void setupTest(BackendListenerContext context) throws Exception {
         try {
             this.filters = new LinkedList<String>();
+            this.modes = new HashSet<>(Arrays.asList("info","debug","error","quiet"));
             this.bulkSize = Integer.parseInt(context.getParameter(ES_BULK_SIZE));
             this.timeoutMs = JMeterUtils.getPropDefault(ES_TIMEOUT_MS, DEFAULT_TIMEOUT_MS);
             this.buildNumber = (JMeterUtils.getProperty(ElasticsearchBackendClient.BUILD_NUMBER) != null && JMeterUtils.getProperty(ElasticsearchBackendClient.BUILD_NUMBER).trim() != "") ? Integer.parseInt(JMeterUtils.getProperty(ElasticsearchBackendClient.BUILD_NUMBER)) : 0;
@@ -72,6 +73,8 @@ public void onFailure(HttpHost host) {
                     .build();
             this.sender = new ElasticSearchMetricSender(this.client, context.getParameter(ES_INDEX).toLowerCase());
             this.sender.createIndex();
+
+            checkTestMode(context.getParameter(ES_TEST_MODE));
 
             String[] filterArray = (context.getParameter(ES_SAMPLE_FILTER).contains(";")) ? context.getParameter(ES_SAMPLE_FILTER).split(";") : new String[] {context.getParameter(ES_SAMPLE_FILTER)};
             if(filterArray.length >= 1 && filterArray[0].trim() != "") {
@@ -131,7 +134,20 @@ public void teardownTest(BackendListenerContext context) throws Exception {
         if(this.sender.getListSize() > 0) {
             this.sender.sendRequest();
         }
-        client.close();
+        this.sender.closeConnection();
         super.teardownTest(context);
     }
+
+    /**
+     * This method checks if the test mode is valid
+     * @param mode The test mode as String
+     */
+    private void checkTestMode(String mode) {
+        if(!this.modes.contains(mode)) {
+            logger.warn("The parameter \"es.test.mode\" isn't set properly. Three modes are allowed: debug ,info, and quiet.");
+            logger.warn(" -- \"debug\": sends request and response details to ElasticSearch. Info only sends the details if the response has an error.");
+            logger.warn(" -- \"info\": should be used in production");
+            logger.warn(" -- \"quiet\": should be used if you don't care to have the details.");
+        }
+    }
 }