Merge pull request #4840 from gchq/gh-4839

#4839 Change record count filter to allow counting of records at a cu…

Author: stroomdev66

CHANGELOG.md

@@ -19,8 +19,6 @@ DO NOT ADD CHANGES HERE - ADD THEM USING log_change.sh
 
 * Issue **#4827** : Fix NPE when opening the Nodes screen.
 
-* 
-
 
 ## [v7.9-beta.3] - 2025-03-24
 

stroom-pipeline/src/main/java/stroom/pipeline/filter/RecordCountFilter.java

@@ -52,9 +52,21 @@ public class RecordCountFilter extends AbstractXMLFilter {
     private static final Logger LOGGER = LoggerFactory.getLogger(RecordCountFilter.class);
     private static final int LOG_COUNT = 10000;
 
+    /**
+     * The default depth of records. Set to 2 as we normally count second
+     * level elements.
+     */
+    private static final int DEFAULT_RECORD_DEPTH = 2;
+
     private final RecordCountService recordCountService;
     private final RecordCount recordCount;
 
+    /**
+     * This defines the depth at which to count records. It is zero based (root
+     * element = 0).
+     */
+    private int recordDepth = DEFAULT_RECORD_DEPTH;
+
     private boolean countRead = true;
     private int depth = 0;
     private long logCounter = 0;
@@ -77,7 +89,6 @@ public RecordCountFilter(final RecordCountService recordCountService,
     public void startProcessing() {
         try {
             recordCount.setStartMs(System.currentTimeMillis());
-//            if (recordCount != null && recordCountService != null) {
             if (countRead) {
                 incrementor = () -> {
                     recordCount.getReadIncrementor().increment();
@@ -89,19 +100,6 @@ public void startProcessing() {
                     recordCountService.getWriteIncrementor().increment();
                 };
             }
-//            } else if (recordCount != null) {
-//                if (countRead) {
-//                    incrementor = recordCount.getReadIncrementor();
-//                } else {
-//                    incrementor = recordCount.getWriteIncrementor();
-//                }
-//            } else if (recordCountService != null) {
-//                if (countRead) {
-//                    incrementor = recordCountService.getReadIncrementor();
-//                } else {
-//                    incrementor = recordCountService.getWriteIncrementor();
-//                }
-//            }
         } finally {
             super.startProcessing();
         }
@@ -158,7 +156,7 @@ public void startElement(final String uri, final String localName, final String
 
         depth++;
 
-        if (depth == 2) {
+        if (depth == recordDepth) {
             // This is a first level element.
             incrementor.increment();
 
@@ -203,4 +201,13 @@ public void endElement(final String uri, final String localName, final String qN
     public void setCountRead(final boolean countRead) {
         this.countRead = countRead;
     }
+
+    @PipelineProperty(
+            description = "The depth of XML elements to count records.",
+            defaultValue = "1",
+            displayPriority = 2)
+    public void setRecordDepth(final int recordDepth) {
+        // Add a fudge in here to cope with legacy depth being 0 based.
+        this.recordDepth = recordDepth + 1;
+    }
 }

unreleased_changes/20250327_132012_671__2334.md

@@ -0,0 +1,24 @@
+* Issue **#4839** : Change record count filter to allow counting of records at a custom depth to match split filter.
+
+
+```sh
+# ********************************************************************************
+# Issue title: Split depth during stepping is always `1`
+# Issue link:  https://github.com/gchq/stroom/issues/2334
+# ********************************************************************************
+
+# ONLY the top line will be included as a change entry in the CHANGELOG.
+# The entry should be in GitHub flavour markdown and should be written on a SINGLE
+# line with no hard breaks. You can have multiple change files for a single GitHub issue.
+# The  entry should be written in the imperative mood, i.e. 'Fix nasty bug' rather than
+# 'Fixed nasty bug'.
+#
+# Examples of acceptable entries are:
+#
+#
+# * Issue **123** : Fix bug with an associated GitHub issue in this repository
+#
+# * Issue **namespace/other-repo#456** : Fix bug with an associated GitHub issue in another repository
+#
+# * Fix bug with no associated GitHub issue.
+```