#31 - Added support for variables, switched to ES 6.4 low-level client

Author: anthonygauthier

pom.xml

@@ -3,7 +3,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>io.github.delirius325</groupId>
 	<artifactId>jmeter.backendlistener.elasticsearch</artifactId>
-	<version>2.4.3</version>
+	<version>2.5.0</version>
 	<packaging>jar</packaging>
 
 	<name>jmeter.backendlistener.elasticsearch</name>
@@ -44,7 +44,7 @@
 		<junit.platform.version>1.0.0</junit.platform.version>
 		<org.apache.jmeter.version>4.0</org.apache.jmeter.version>
 		<org.apache.commons>3.7</org.apache.commons>
-		<org.elasticsearch.client>6.2.0</org.elasticsearch.client>
+		<org.elasticsearch.client>6.4.0</org.elasticsearch.client>
 	</properties>
 	<dependencies>
 		<dependency>

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

@@ -79,6 +79,7 @@ public Map<String, Object> getMetric(BackendListenerContext context) throws Exce
         addAssertions();
         addElapsedTime(sdf);
         addCustomFields(context);
+        checkCustomVariables();
 
         return this.json;
     }
@@ -165,6 +166,24 @@ private void addDetails() {
         this.json.put("ResponseMessage", this.sampleResult.getResponseMessage());
     }
 
+    /**
+     * This method will parse the headers and look for custom variables passed through as header.
+     * This is a work-around the native behaviour of JMeter where variables are not accessible within the
+     * backend listener.
+     *
+     * NOTE: This will be fixed as soon as a patch comes in for JMeter to change the behaviour.
+     */
+    private void checkCustomVariables() {
+        String[] lines = this.sampleResult.getRequestHeaders().split("\n");
+
+        for(int i=0; i < lines.length; i++) {
+            String[] header = lines[i].split(":");
+            if(header[0].contains("es-")) {
+                this.json.put(header[0].replaceAll("es-", "").trim(), header[1].trim());
+            }
+        }
+    }
+
     /**
      * This method is meant to return the elapsed time in a human readable format. The purpose of this is
      * mostly for build comparison in Kibana. By doing this, the user is able to set the X-axis of his graph

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

@@ -5,6 +5,8 @@
 import org.apache.http.entity.ContentType;
 import org.apache.http.message.BasicHeader;
 import org.apache.http.nio.entity.NStringEntity;
+import org.elasticsearch.client.Request;
+import org.elasticsearch.client.RequestOptions;
 import org.elasticsearch.client.Response;
 import org.elasticsearch.client.RestClient;
 import org.slf4j.Logger;
@@ -22,15 +24,13 @@ public class ElasticSearchMetricSender {
     private List<String> metricList;
     private String authUser;
     private String authPwd;
-    private BasicHeader authHeader;
 
     public ElasticSearchMetricSender(RestClient cli, String index, String user, String pwd) {
         this.client = cli;
         this.esIndex = index;
         this.metricList = new LinkedList<String>();
         this.authUser = user.trim();
         this.authPwd = pwd.trim();
-        this.authHeader = null;
     }
 
     /**
@@ -72,26 +72,28 @@ public void createIndex() {
      * All is being sent through the low-level ElasticSearch REST Client.
      */
     public void sendRequest() {
+        Request request = new Request("POST", "/" + this.esIndex + "/SampleResult/_bulk");
+        StringBuilder bulkRequestBody = new StringBuilder();
         String actionMetaData = String.format("{ \"index\" : { \"_index\" : \"%s\", \"_type\" : \"%s\" } }%n", this.esIndex, "SampleResult");
 
-        StringBuilder bulkRequestBody = new StringBuilder();
         for (String metric : this.metricList) {
             bulkRequestBody.append(actionMetaData);
             bulkRequestBody.append(metric);
             bulkRequestBody.append("\n");
         }
 
         HttpEntity entity = new NStringEntity(bulkRequestBody.toString(), ContentType.APPLICATION_JSON);
+        request.setEntity(entity);
+
         try {
             if(!this.authUser.equals("") && !this.authPwd.equals("")) {
                 String encodedCredentials = Base64.getEncoder().encodeToString((this.authUser + ":" + this.authPwd).getBytes());
-
-                this.authHeader = new BasicHeader("Authorization", "Basic " + encodedCredentials);
+                RequestOptions.Builder options = request.getOptions().toBuilder();
+                options.addHeader("Authorization", "Basic " + encodedCredentials);
+                request.setOptions(options);
             }
 
-            Response response = (this.authHeader != null)
-                ? this.client.performRequest("POST", "/"+ this.esIndex +"/SampleResult/_bulk", Collections.emptyMap(), entity, this.authHeader)
-                : this.client.performRequest("POST", "/"+ this.esIndex +"/SampleResult/_bulk", Collections.emptyMap(), entity);
+            Response response = this.client.performRequest(request);
 
             if(response.getStatusLine().getStatusCode() != HttpStatus.SC_OK) {
                 if(logger.isErrorEnabled()) {

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

@@ -7,6 +7,7 @@
 import org.apache.jmeter.util.JMeterUtils;
 import org.apache.jmeter.visualizers.backend.AbstractBackendListenerClient;
 import org.apache.jmeter.visualizers.backend.BackendListenerContext;
+import org.elasticsearch.client.Node;
 import org.elasticsearch.client.RestClient;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -67,7 +68,7 @@ public void setupTest(BackendListenerContext context) throws Exception {
                     .setSocketTimeout((int) timeoutMs))
                     .setFailureListener(new RestClient.FailureListener() {
                         @Override
-                        public void onFailure(HttpHost host) {
+                        public void onFailure(Node node) {
                             throw new IllegalStateException();
                         }
                     })