ref(logging): enhance logging for dynamic ES sample filters and improve parameter conversion

Signed-off-by: Johnny Hujol <itudoben@users.noreply.github.com>

Author: itudoben

README.md

@@ -16,6 +16,7 @@ JMeter ElasticSearch Backend Listener is a JMeter plugin enabling you to send te
 * Filters
   * Only send the samples you want by using Filters! Simply type them as follows in the field ``es.sample.filter`` : ``filter1;filter2;filter3`` or ``sampleLabel_must_contain_this``.
   * You can also choose to exclude certain samplers; `!!exclude_this;filter1;filter2`
+  * SYS_DYNAMIC_ES_PER_SAMPLE_FILTER is a System property that can be set before the ElasticsearchBackendClient#handleSampleResults(...) is called. It will override the es.sample.filter value set in the backendlistener configuration.
 * Specific fields ```field1;field2;field3`
   * Specify fields that you want to send to ElasticSearch (possible fields below)
      * AllThreads

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

@@ -173,6 +173,18 @@ public void onFailure(Node node) {
     }
   }
 
+  /**
+   * Method that converts a semicolon separated list contained in a System property {@link System#getProperty(String)} into a string set
+   *
+   * @param propertyName
+   * @param set
+   */
+  private void convertSystemPropertyToSet(String propertyName, Set<String> set) {
+    String value = System.getProperty(propertyName);
+
+    convertValueToSet(propertyName, set, value);
+  }
+
   /**
    * Method that converts a semicolon separated list contained in a parameter into a string set
    *
@@ -181,8 +193,14 @@ public void onFailure(Node node) {
    * @param set
    */
   private void convertParameterToSet(BackendListenerContext context, String parameter, Set<String> set) {
-    String[] array = (context.getParameter(parameter).contains(";")) ? context.getParameter(parameter).split(";")
-      : new String[]{context.getParameter(parameter)};
+    String value = context.getParameter(parameter);
+
+    convertValueToSet(parameter, set, value);
+  }
+
+  private static void convertValueToSet(String parameter, Set<String> set, String value) {
+    String[] array = (value.contains(";")) ? value.split(";")
+      : new String[]{value};
     if (array.length > 0 && !array[0].trim().equals("")) {
       for (String entry : array) {
         set.add(entry.toLowerCase().trim());
@@ -243,6 +261,15 @@ public void handleSampleResults(List<SampleResult> results, BackendListenerConte
       return;
     }
 
+    if (System.getProperty("SYS_DYNAMIC_ES_PER_SAMPLE_FILTER") != null) {
+      // Override filters from ES_SAMPLE_FILTER if exists
+      this.filters.clear();
+      logger.info("============>  Property SYS_DYNAMIC_ES_PER_SAMPLE_FILTER filters: {}", System.getProperty("SYS_DYNAMIC_ES_PER_SAMPLE_FILTER"));
+      convertSystemPropertyToSet("SYS_DYNAMIC_ES_PER_SAMPLE_FILTER", this.filters);
+      logger.info("============>  Property SYS_DYNAMIC_ES_PER_SAMPLE_FILTER filters: {}", this.filters);
+    }
+
+    final String filtersAsString = (this.filters.isEmpty()) ? "no filters" : String.join(", ", this.filters);
     for (SampleResult sr : results) {
       String respString = sr.getResponseDataAsString();
       int endIndex = Math.min(100, respString.length());
@@ -262,6 +289,10 @@ public void handleSampleResults(List<SampleResult> results, BackendListenerConte
             "The ElasticSearch Backend Listener was unable to add sampler to the list of samplers to send... More info in JMeter's console.");
           e.printStackTrace();
         }
+        logger.info("Sampler result processed {} with filters {}", sr.getSampleLabel(), filtersAsString);
+      }
+      else {
+        logger.info("Sampler result skipped {} with filters {}", sr.getSampleLabel(), filtersAsString);
       }
     }