Made LogBatchPurger's batch size configurable (#880)

jongpie · web-flow · commit b34b2c0e1741 · 2025-07-21T16:15:08.000-04:00
* Added the ability to configure the default batch size in LogBatchPurger, using the new LoggerParameter__mdt record LogBatchPurgerDefaultBatchSize
diff --git a/README.md b/README.md
@@ -5,13 +5,13 @@
 
 The most robust observability solution for Salesforce experts. Built 100% natively on the platform, and designed to work seamlessly with Apex, Lightning Components, Flow, OmniStudio, and integrations.
 
-## Unlocked Package - v4.16.2
+## Unlocked Package - v4.16.3
 
-[![Install Unlocked Package in a Sandbox](./images/btn-install-unlocked-package-sandbox.png)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04tKe0000011Mi9IAE)
-[![Install Unlocked Package in Production](./images/btn-install-unlocked-package-production.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04tKe0000011Mi9IAE)
+[![Install Unlocked Package in a Sandbox](./images/btn-install-unlocked-package-sandbox.png)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04tKe0000011Mr1IAE)
+[![Install Unlocked Package in Production](./images/btn-install-unlocked-package-production.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04tKe0000011Mr1IAE)
 [![View Documentation](./images/btn-view-documentation.png)](https://github.com/jongpie/NebulaLogger/wiki)
 
-`sf package install --wait 20 --security-type AdminsOnly --package 04tKe0000011Mi9IAE`
+`sf package install --wait 20 --security-type AdminsOnly --package 04tKe0000011Mr1IAE`
 
 ---
 
diff --git a/docs/apex/Configuration/LoggerParameter.md b/docs/apex/Configuration/LoggerParameter.md
@@ -34,6 +34,10 @@ Indicates if Nebula Logger will append its own log entries about the logging sys
 
 Indicates if Nebula Logger&apos;s tagging system is enabled. Controlled by the custom metadata record `LoggerParameter.EnableTagging`, or `true` as the default
 
+#### `LOG_BATCH_PURGER_DEFAULT_BATCH_SIZE` → `Integer`
+
+Controls the default batch size used by the batchable class `LogBatchPurger` when purging old logging data. Controlled by the custom metadata record `LoggerParameter.LogBatchPurgerDefaultBatchSize`, or `500` as the default
+
 #### `NORMALIZE_SCENARIO_DATA` → `Boolean`
 
 Indicates if Nebula Logger will store scenarios in the custom object `LoggerScenario__c`, or in the fields `Log__c.TransactionScenarioName__c` &amp; `LogEntry__c.EntryScenario__c`. Controlled by the custom metadata record `LoggerParameter.NormalizeScenarioData`, or `true` as the default
diff --git a/docs/apex/Log-Management/LogBatchPurgeController.md b/docs/apex/Log-Management/LogBatchPurgeController.md
@@ -74,7 +74,7 @@ The instance of `List&lt;PicklistOption&gt;`, containing all picklist options fo
 
 #### `runBatchPurge()` → `String`
 
-execute the logBatchPurger batch with batch size 2000
+Executes the LogBatchPurger batch job with the default batch size
 
 ##### Return
 
diff --git a/docs/apex/Log-Management/LogBatchPurger.md b/docs/apex/Log-Management/LogBatchPurger.md
@@ -64,7 +64,7 @@ Integer
 
 **Description**
 
-The default `Integer` value of `2000`
+The `Integer` value configured in the custom metadata record `LoggerParameter.LogBatchPurgerDefaultBatchSize`, or `500` as the default
 
 #### `setChainedBatchSize(Integer chainedBatchSize)` → `LogBatchPurger`
 
diff --git a/docs/apex/Logger-Engine/LogEntryEventBuilder.md b/docs/apex/Logger-Engine/LogEntryEventBuilder.md
@@ -52,6 +52,8 @@ Used by `Logger` to instantiate a new instance of `LogEntryEventBuilder`
 
 #### `heapSizeMax` → `Integer`
 
+#### `isDataMaskingEnabled` → `Boolean`
+
 #### `mobilePushApexCallsMax` → `Integer`
 
 #### `publishImmediateDmlStatementsMax` → `Integer`
@@ -66,10 +68,20 @@ Used by `Logger` to instantiate a new instance of `LogEntryEventBuilder`
 
 #### `soslSearchesMax` → `Integer`
 
+#### `textField` → `Schema.SObjectField`
+
+#### `textValue` → `String`
+
+#### `wasMasked` → `Boolean`
+
+#### `wasTruncated` → `Boolean`
+
 ---
 
 ### Methods
 
+#### `TextFieldValueCleaner(LoggerSettings__c settings, Schema.SObjectField textField, String originalTextValue)` → `public`
+
 #### `addTag(String tag)` → `LogEntryEventBuilder`
 
 Appends the tag to the existing list of tags
diff --git a/nebula-logger/core.package.xml b/nebula-logger/core.package.xml
@@ -725,6 +725,7 @@
         <members>LoggerParameter.EnableLoggerSystemMessages</members>
         <members>LoggerParameter.EnableStackTraceParsing</members>
         <members>LoggerParameter.EnableTagging</members>
+        <members>LoggerParameter.LogBatchPurgerDefaultBatchSize</members>
         <members>LoggerParameter.LogEntryEventStreamDisplayFields</members>
         <members>LoggerParameter.NormalizeScenarioData</members>
         <members>LoggerParameter.NormalizeTagData</members>
diff --git a/nebula-logger/core/main/configuration/classes/LoggerParameter.cls b/nebula-logger/core/main/configuration/classes/LoggerParameter.cls
@@ -102,6 +102,20 @@ public class LoggerParameter {
     private set;
   }
 
+  /**
+   * @description Controls the default batch size used by the batchable class `LogBatchPurger` when purging old logging data.
+   *              Controlled by the custom metadata record `LoggerParameter.LogBatchPurgerDefaultBatchSize`, or `500` as the default
+   */
+  public static final Integer LOG_BATCH_PURGER_DEFAULT_BATCH_SIZE {
+    get {
+      if (LOG_BATCH_PURGER_DEFAULT_BATCH_SIZE == null) {
+        LOG_BATCH_PURGER_DEFAULT_BATCH_SIZE = getInteger('LogBatchPurgerDefaultBatchSize', 500);
+      }
+      return LOG_BATCH_PURGER_DEFAULT_BATCH_SIZE;
+    }
+    private set;
+  }
+
   /**
    * @description Indicates if Nebula Logger will store scenarios in the custom object `LoggerScenario__c`,
    *              or in the fields `Log__c.TransactionScenarioName__c` & `LogEntry__c.EntryScenario__c`.
diff --git a/nebula-logger/core/main/configuration/customMetadata/LoggerParameter.LogBatchPurgerDefaultBatchSize.md-meta.xml b/nebula-logger/core/main/configuration/customMetadata/LoggerParameter.LogBatchPurgerDefaultBatchSize.md-meta.xml
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomMetadata xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+    <label>Log Batch Purger: Default Batch Size</label>
+    <protected>false</protected>
+    <values>
+        <field>Comments__c</field>
+        <value xsi:nil="true"/>
+    </values>
+    <values>
+        <field>Description__c</field>
+        <value xsi:type="xsd:string">The integer value used to control the default batch size used by the batchable class LogBatchPurger (default is 500).</value>
+    </values>
+    <values>
+        <field>Value__c</field>
+        <value xsi:type="xsd:string">500</value>
+    </values>
+</CustomMetadata>
diff --git a/nebula-logger/core/main/log-management/classes/LogBatchPurgeController.cls b/nebula-logger/core/main/log-management/classes/LogBatchPurgeController.cls
@@ -88,7 +88,7 @@ public with sharing class LogBatchPurgeController {
   }
 
   /**
-   * @description execute the logBatchPurger batch with batch size 2000
+   * @description Executes the LogBatchPurger batch job with the default batch size
    * @return Returns the ID of the Schema.AsyncApexJob object associated with the LogBatchPurger job as a string
    */
   @AuraEnabled
diff --git a/nebula-logger/core/main/log-management/classes/LogBatchPurger.cls b/nebula-logger/core/main/log-management/classes/LogBatchPurger.cls
@@ -10,7 +10,6 @@
  */
 @SuppressWarnings('PMD.AvoidGlobalModifier, PMD.CognitiveComplexity, PMD.CyclomaticComplexity, PMD.ExcessiveParameterList')
 global with sharing class LogBatchPurger implements Database.Batchable<SObject>, Database.Stateful {
-  private static final Integer DEFAULT_BATCH_SIZE = 2000;
   private static final Date LOG_RETENTION_END_DATE = System.today();
   @TestVisible
   private static final String NO_DELETE_ACCESS_EXCEPTION_MESSAGE = 'User does not have access to delete logs';
@@ -36,10 +35,10 @@ global with sharing class LogBatchPurger implements Database.Batchable<SObject>,
 
   /**
    * @description Returns the default batch size used when running `LogBatchPurger`
-   * @return   The default `Integer` value of `2000`
+   * @return   The `Integer` value configured in the custom metadata record `LoggerParameter.LogBatchPurgerDefaultBatchSize`, or `500` as the default
    */
   public static Integer getDefaultBatchSize() {
-    return DEFAULT_BATCH_SIZE;
+    return LoggerParameter.LOG_BATCH_PURGER_DEFAULT_BATCH_SIZE;
   }
 
   /**
diff --git a/nebula-logger/core/main/logger-engine/classes/Logger.cls b/nebula-logger/core/main/logger-engine/classes/Logger.cls
@@ -15,7 +15,7 @@
 global with sharing class Logger {
   // There's no reliable way to get the version number dynamically in Apex
   @TestVisible
-  private static final String CURRENT_VERSION_NUMBER = 'v4.16.2';
+  private static final String CURRENT_VERSION_NUMBER = 'v4.16.3';
   private static final System.LoggingLevel FALLBACK_LOGGING_LEVEL = System.LoggingLevel.DEBUG;
   private static final List<LogEntryEventBuilder> LOG_ENTRIES_BUFFER = new List<LogEntryEventBuilder>();
   private static final String MISSING_SCENARIO_ERROR_MESSAGE = 'No logger scenario specified. A scenario is required for logging in this org.';
diff --git a/nebula-logger/core/main/logger-engine/lwc/logger/loggerService.js b/nebula-logger/core/main/logger-engine/lwc/logger/loggerService.js
@@ -10,7 +10,7 @@ import LoggerServiceTaskQueue from './loggerServiceTaskQueue';
 import getSettings from '@salesforce/apex/ComponentLogger.getSettings';
 import saveComponentLogEntries from '@salesforce/apex/ComponentLogger.saveComponentLogEntries';
 
-const CURRENT_VERSION_NUMBER = 'v4.16.2';
+const CURRENT_VERSION_NUMBER = 'v4.16.3';
 
 const CONSOLE_OUTPUT_CONFIG = {
   messagePrefix: `%c  Nebula Logger ${CURRENT_VERSION_NUMBER}  `,
diff --git a/nebula-logger/core/tests/configuration/classes/LoggerParameter_Tests.cls b/nebula-logger/core/tests/configuration/classes/LoggerParameter_Tests.cls
@@ -102,6 +102,20 @@ private class LoggerParameter_Tests {
     System.Assert.areEqual(mockValue, returnedValue);
   }
 
+  @IsTest
+  static void it_should_return_constant_value_for_log_batch_purger_default_batch_size() {
+    Integer mockValue = 1234;
+    LoggerParameter__mdt mockParameter = new LoggerParameter__mdt(
+      DeveloperName = 'LogBatchPurgerDefaultBatchSize',
+      Value__c = System.JSON.serialize(mockValue)
+    );
+    LoggerParameter.setMock(mockParameter);
+
+    Integer returnedValue = LoggerParameter.LOG_BATCH_PURGER_DEFAULT_BATCH_SIZE;
+
+    System.Assert.areEqual(mockValue, returnedValue);
+  }
+
   @IsTest
   static void it_should_return_constant_value_for_normalize_scenario_data() {
     Boolean mockValue = false;
diff --git a/nebula-logger/core/tests/log-management/classes/LogBatchPurger_Tests.cls b/nebula-logger/core/tests/log-management/classes/LogBatchPurger_Tests.cls
@@ -54,8 +54,17 @@ private class LogBatchPurger_Tests {
   }
 
   @IsTest
-  static void it_returns_2000_for_the_default_batch_size() {
-    System.Assert.areEqual(2000, LogBatchPurger.getDefaultBatchSize());
+  static void it_returns_configured_logger_parameter_value_for_the_default_batch_size() {
+    Integer mockValue = 1234;
+    LoggerParameter__mdt mockParameter = new LoggerParameter__mdt(
+      DeveloperName = 'LogBatchPurgerDefaultBatchSize',
+      Value__c = System.JSON.serialize(mockValue)
+    );
+    LoggerParameter.setMock(mockParameter);
+
+    Integer returnedValue = LogBatchPurger.getDefaultBatchSize();
+
+    System.Assert.areEqual(mockValue, returnedValue);
   }
 
   @IsTest
diff --git a/nebula-logger/extra-tests/bundled-custom-metadata-type-records/CMDT_LoggerParameter_Tests.cls b/nebula-logger/extra-tests/bundled-custom-metadata-type-records/CMDT_LoggerParameter_Tests.cls
@@ -79,6 +79,17 @@ private class CMDT_LoggerParameter_Tests {
     System.Assert.areEqual('true', bundledRecord.Value__c);
   }
 
+  @IsTest
+  static void it_has_correct_record_for_log_batch_purger_default_batch_size() {
+    LoggerParameter__mdt bundledRecord = LoggerParameter__mdt.getInstance('LogBatchPurgerDefaultBatchSize');
+
+    System.Assert.isNotNull(bundledRecord, 'Record is missing');
+    System.Assert.isNull(bundledRecord.Comments__c, 'Comments should be null/blank');
+    System.Assert.isNotNull(bundledRecord.Description__c, 'Description is missing');
+    System.Assert.areEqual('Log Batch Purger: Default Batch Size', bundledRecord.Label);
+    System.Assert.areEqual('500', bundledRecord.Value__c);
+  }
+
   @IsTest
   static void it_has_correct_record_for_normalize_scenario_data() {
     LoggerParameter__mdt bundledRecord = LoggerParameter__mdt.getInstance('NormalizeScenarioData');
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "nebula-logger",
-  "version": "4.16.2",
+  "version": "4.16.3",
   "description": "The most robust logger for Salesforce. Works with Apex, Lightning Components, Flow, Process Builder & Integrations. Designed for Salesforce admins, developers & architects.",
   "author": "Jonathan Gillespie",
   "license": "MIT",
diff --git a/sfdx-project.json b/sfdx-project.json
@@ -9,9 +9,9 @@
       "path": "./nebula-logger/core",
       "definitionFile": "./config/scratch-orgs/base-scratch-def.json",
       "scopeProfiles": true,
-      "versionNumber": "4.16.2.NEXT",
-      "versionName": "Origin Location Parsing Improvements",
-      "versionDescription": "Tweaked how origin location is parsed when External entry point is the first line of a stack trace",
+      "versionNumber": "4.16.3.NEXT",
+      "versionName": "Configurable Batch Size for LogBatchPurger",
+      "versionDescription": "Added new LoggerParameter__mdt record LogBatchPurgerDefaultBatchSize to control the default batch size used by the batchable Apex class LogBatchPurger",
       "postInstallUrl": "https://github.com/jongpie/NebulaLogger/wiki",
       "releaseNotesUrl": "https://github.com/jongpie/NebulaLogger/releases",
       "unpackagedMetadata": {
@@ -218,6 +218,7 @@
     "Nebula Logger - Core@4.16.0-spring-'25-release": "04t5Y0000015pGyQAI",
     "Nebula Logger - Core@4.16.1-data-masking-&-string-truncation-improvements": "04tKe0000011MXEIA2",
     "Nebula Logger - Core@4.16.2-origin-location-parsing-improvements": "04tKe0000011Mi9IAE",
+    "Nebula Logger - Core@4.16.3-configurable-batch-size-for-logbatchpurger": "04tKe0000011Mr1IAE",
     "Nebula Logger - Core Plugin - Async Failure Additions": "0Ho5Y000000blO4SAI",
     "Nebula Logger - Core Plugin - Async Failure Additions@1.0.0": "04t5Y0000015lhiQAA",
     "Nebula Logger - Core Plugin - Async Failure Additions@1.0.1": "04t5Y0000015lhsQAA",

Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ public with sharing class LogBatchPurgeController {`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`/**`
`91`		`- * @description execute the logBatchPurger batch with batch size 2000`
	`91`	`+ * @description Executes the LogBatchPurger batch job with the default batch size`
`92`	`92`	`* @return Returns the ID of the Schema.AsyncApexJob object associated with the LogBatchPurger job as a string`
`93`	`93`	`*/`
`94`	`94`	`@AuraEnabled`