Adding Redacted Keys

CHANGELOG.md

@@ -2,13 +2,18 @@
 
 ## TBD 
 
+### Changed
+
+- Renamed the configuration option `filters` to `redactedKeys`. `filters` is now marked as deprecated and will be removed in the next major release. [#217](https://github.com/bugsnag/bugsnag-java/pull/217)
+
+### Bug Fixes
+
 * Update `BugsnagImportSelector` to allow major versions that do not have a minor version.
   fixes [issue #211](https://github.com/bugsnag/bugsnag-java/issues/211).
   [#213](https://github.com/bugsnag/bugsnag-java/pull/213)
 
 * Add a null check for `Severity` to the notify override method. [#214](https://github.com/bugsnag/bugsnag-java/pull/214)
 
-
 ## 3.7.1 (2023-10-25)
 
 * Restore `BugsnagServletContainerInitializer` and `BugsnagServletRequestListener` to the `com.bugsnag.servlet` package.

bugsnag/src/main/java/com/bugsnag/Bugsnag.java

@@ -232,14 +232,32 @@ public void setEndpoint(String endpoint) {
      * Use this when you want to ensure sensitive information, such as passwords
      * or credit card information is stripped from metaData you send to Bugsnag.
      * Any keys in metaData which contain these strings will be marked as
-     * [FILTERED] when send to Bugsnag.
+     * [REDACTED] when send to Bugsnag.
+     * @deprecated to be removed and replaced with setRedactedKeys
      *
      * @param filters a list of String keys to filter from metaData
      */
+    @Deprecated
     public void setFilters(String... filters) {
         config.filters = filters;
+        setRedactedKeys(filters);
     }
 
+    /**
+     * Set which keys should be redacted when sending metaData to Bugsnag.
+     * Use this when you want to ensure sensitive information, such as passwords
+     * or credit card information is stripped from metaData you send to Bugsnag.
+     * Any keys in metaData which contain these strings will be marked as
+     * [REDACTED] when send to Bugsnag.
+     *
+     * @param redactedKeys a list of String keys to be redacted from metaData
+     */
+    public void setRedactedKeys(String... redactedKeys) {
+        config.redactedKeys = redactedKeys;
+    }
+
+
+
     /**
      * Set which exception classes should be ignored (not sent) by Bugsnag.
      *

bugsnag/src/main/java/com/bugsnag/BugsnagAppender.java

@@ -48,8 +48,8 @@ public class BugsnagAppender extends UnsynchronizedAppenderBase<ILoggingEvent> {
     /** Bugsnag error server endpoint. */
     private String endpoint;
 
-    /** Property names that should be filtered out before sending to Bugsnag servers. */
-    private Set<String> filteredProperties = new HashSet<String>();
+    /** Property names that should be redacted out before sending to Bugsnag servers. */
+    private Set<String> redactedKeys = new HashSet<String>();
 
     /** Exception classes to be ignored. */
     private Set<String> ignoredClasses = new HashSet<String>();
@@ -254,8 +254,8 @@ private Bugsnag createBugsnag() {
             bugsnag.setTimeout(timeout);
         }
 
-        if (filteredProperties.size() > 0) {
-            bugsnag.setFilters(filteredProperties.toArray(new String[0]));
+        if (redactedKeys.size() > 0) {
+            bugsnag.setRedactedKeys(redactedKeys.toArray(new String[0]));
         }
 
         bugsnag.setIgnoreClasses(ignoredClasses.toArray(new String[0]));
@@ -375,23 +375,49 @@ public void setEndpoint(String endpoint) {
 
     /**
      * @see Bugsnag#setFilters(String...)
+     * @deprecated use #setRedactedKey(String) instead
      */
+    @Deprecated
     public void setFilteredProperty(String filter) {
-        this.filteredProperties.add(filter);
+        this.redactedKeys.add(filter);
 
         if (bugsnag != null) {
-            bugsnag.setFilters(this.filteredProperties.toArray(new String[0]));
+            bugsnag.setRedactedKeys(this.redactedKeys.toArray(new String[0]));
         }
     }
 
     /**
      * @see Bugsnag#setFilters(String...)
+     * @deprecated use #setRedactedKeys(String) instead
      */
+    @Deprecated
     public void setFilteredProperties(String filters) {
-        this.filteredProperties.addAll(split(filters));
+        this.redactedKeys.addAll(split(filters));
 
         if (bugsnag != null) {
-            bugsnag.setFilters(this.filteredProperties.toArray(new String[0]));
+            bugsnag.setRedactedKeys(this.redactedKeys.toArray(new String[0]));
+        }
+    }
+
+    /**
+     * @see Bugsnag#setRedactedKeys(String...)
+     */
+    public void setRedactedKey(String redactedKey) {
+        this.redactedKeys.add(redactedKey);
+
+        if (bugsnag != null) {
+            bugsnag.setRedactedKeys(this.redactedKeys.toArray(new String[0]));
+        }
+    }
+
+    /**
+     * @see Bugsnag#setRedactedKeys(String...)
+     */
+    public void setRedactedKeys(String redactedKeys) {
+        this.redactedKeys.addAll(split(redactedKeys));
+
+        if (bugsnag != null) {
+            bugsnag.setRedactedKeys(this.redactedKeys.toArray(new String[0]));
         }
     }
 

bugsnag/src/main/java/com/bugsnag/Configuration.java

@@ -38,6 +38,7 @@ public class Configuration {
     public Delivery delivery = new AsyncHttpDelivery(SyncHttpDelivery.DEFAULT_NOTIFY_ENDPOINT);
     public Delivery sessionDelivery =
             new AsyncHttpDelivery(SyncHttpDelivery.DEFAULT_SESSION_ENDPOINT);
+    public String[] redactedKeys = new String[]{"password", "secret", "Authorization", "Cookie"};
     public String[] filters = new String[]{"password", "secret", "Authorization", "Cookie"};
     public String[] ignoreClasses;
     public String[] notifyReleaseStages = null;

bugsnag/src/main/java/com/bugsnag/Report.java

@@ -2,7 +2,7 @@
 
 import com.bugsnag.serialization.Expose;
 
-import com.bugsnag.util.FilteredMap;
+import com.bugsnag.util.RedactedKeysMap;
 
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -126,7 +126,7 @@ public Map<String, String> getUser() {
 
     @Expose
     public Map<String, Object> getMetaData() {
-        return new FilteredMap(diagnostics.metaData, Arrays.asList(config.filters));
+        return new RedactedKeysMap(diagnostics.metaData, Arrays.asList(config.redactedKeys));
     }
 
     @Expose