diff --git a/backtrace-library/src/androidTest/java/backtraceio/library/breadcrumbs/BacktraceBreadcrumbsTest.java b/backtrace-library/src/androidTest/java/backtraceio/library/breadcrumbs/BacktraceBreadcrumbsTest.java index a538f69a5..df70e58fb 100644 --- a/backtrace-library/src/androidTest/java/backtraceio/library/breadcrumbs/BacktraceBreadcrumbsTest.java +++ b/backtrace-library/src/androidTest/java/backtraceio/library/breadcrumbs/BacktraceBreadcrumbsTest.java @@ -9,6 +9,7 @@ import android.content.Context; import androidx.test.ext.junit.runners.AndroidJUnit4; import androidx.test.platform.app.InstrumentationRegistry; +import backtraceio.library.enums.BacktraceBreadcrumbLevel; import backtraceio.library.enums.BacktraceBreadcrumbType; import java.io.File; import java.io.IOException; @@ -145,6 +146,203 @@ public void testAddBreadcrumbRejectsDisabledType() { } } + @Test + public void testAddBreadcrumbRejectsLevelBelowMinimum() { + try { + cleanUp(); + + backtraceBreadcrumbs = + new BacktraceBreadcrumbs(context.getFilesDir().getAbsolutePath()); + backtraceBreadcrumbs.enableBreadcrumbs( + context, + BacktraceBreadcrumbType.ALL, + BacktraceBreadcrumbs.DEFAULT_MAX_LOG_SIZE_BYTES, + BacktraceBreadcrumbLevel.WARNING); + + // Below threshold, dropped + assertFalse(backtraceBreadcrumbs.addBreadcrumb( + "test-debug", BacktraceBreadcrumbType.MANUAL, BacktraceBreadcrumbLevel.DEBUG)); + assertFalse(backtraceBreadcrumbs.addBreadcrumb( + "test-info", BacktraceBreadcrumbType.MANUAL, BacktraceBreadcrumbLevel.INFO)); + + List breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile( + context.getFilesDir().getAbsolutePath()); + + // Only the configuration breadcrumb should be present. + assertEquals(1, breadcrumbLogFileData.size()); + } catch (Exception ex) { + fail(ex.getMessage()); + } + } + + @Test + public void testAddBreadcrumbAcceptsLevelAtOrAboveMinimum() { + try { + cleanUp(); + + backtraceBreadcrumbs = + new BacktraceBreadcrumbs(context.getFilesDir().getAbsolutePath()); + backtraceBreadcrumbs.enableBreadcrumbs( + context, + BacktraceBreadcrumbType.ALL, + BacktraceBreadcrumbs.DEFAULT_MAX_LOG_SIZE_BYTES, + BacktraceBreadcrumbLevel.WARNING); + + // At threshold, retain + assertTrue(backtraceBreadcrumbs.addBreadcrumb( + "test-warning", BacktraceBreadcrumbType.MANUAL, BacktraceBreadcrumbLevel.WARNING)); + // Above threshold, retain + assertTrue(backtraceBreadcrumbs.addBreadcrumb( + "test-error", BacktraceBreadcrumbType.MANUAL, BacktraceBreadcrumbLevel.ERROR)); + assertTrue(backtraceBreadcrumbs.addBreadcrumb( + "test-fatal", BacktraceBreadcrumbType.MANUAL, BacktraceBreadcrumbLevel.FATAL)); + + List breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile( + context.getFilesDir().getAbsolutePath()); + + // Configuration breadcrumb + three added. + assertEquals(4, breadcrumbLogFileData.size()); + + assertEquals("test-warning", new JSONObject(breadcrumbLogFileData.get(1)).get("message")); + assertEquals("test-error", new JSONObject(breadcrumbLogFileData.get(2)).get("message")); + assertEquals("test-fatal", new JSONObject(breadcrumbLogFileData.get(3)).get("message")); + } catch (Exception ex) { + fail(ex.getMessage()); + } + } + + @Test + public void testAddBreadcrumbDefaultMinLevelAcceptsAllLevels() { + try { + // default min level should be DEBUG on setUp() + assertEquals(BacktraceBreadcrumbLevel.DEBUG, backtraceBreadcrumbs.getMinBreadcrumbLevel()); + + assertTrue(backtraceBreadcrumbs.addBreadcrumb( + "test-debug", BacktraceBreadcrumbType.MANUAL, BacktraceBreadcrumbLevel.DEBUG)); + assertTrue(backtraceBreadcrumbs.addBreadcrumb( + "test-info", BacktraceBreadcrumbType.MANUAL, BacktraceBreadcrumbLevel.INFO)); + assertTrue(backtraceBreadcrumbs.addBreadcrumb( + "test-warning", BacktraceBreadcrumbType.MANUAL, BacktraceBreadcrumbLevel.WARNING)); + assertTrue(backtraceBreadcrumbs.addBreadcrumb( + "test-error", BacktraceBreadcrumbType.MANUAL, BacktraceBreadcrumbLevel.ERROR)); + assertTrue(backtraceBreadcrumbs.addBreadcrumb( + "test-fatal", BacktraceBreadcrumbType.MANUAL, BacktraceBreadcrumbLevel.FATAL)); + + List breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile( + context.getFilesDir().getAbsolutePath()); + + // Configuration breadcrumb + five added. + assertEquals(6, breadcrumbLogFileData.size()); + } catch (Exception ex) { + fail(ex.getMessage()); + } + } + + @Test + public void testReEnableBreadcrumbsUpdatesMinLevel() { + try { + cleanUp(); + + backtraceBreadcrumbs = + new BacktraceBreadcrumbs(context.getFilesDir().getAbsolutePath()); + backtraceBreadcrumbs.enableBreadcrumbs( + context, + BacktraceBreadcrumbType.ALL, + BacktraceBreadcrumbs.DEFAULT_MAX_LOG_SIZE_BYTES, + BacktraceBreadcrumbLevel.DEBUG); + assertEquals(BacktraceBreadcrumbLevel.DEBUG, backtraceBreadcrumbs.getMinBreadcrumbLevel()); + + // Initial threshold lets DEBUG through. + assertTrue(backtraceBreadcrumbs.addBreadcrumb( + "pre-change", BacktraceBreadcrumbType.MANUAL, BacktraceBreadcrumbLevel.DEBUG)); + + // Tighten threshold by re-enabling. + backtraceBreadcrumbs.enableBreadcrumbs( + context, + BacktraceBreadcrumbType.ALL, + BacktraceBreadcrumbs.DEFAULT_MAX_LOG_SIZE_BYTES, + BacktraceBreadcrumbLevel.ERROR); + assertEquals(BacktraceBreadcrumbLevel.ERROR, backtraceBreadcrumbs.getMinBreadcrumbLevel()); + + // Now DEBUG is dropped; ERROR still goes through. + assertFalse(backtraceBreadcrumbs.addBreadcrumb( + "post-change-debug", BacktraceBreadcrumbType.MANUAL, BacktraceBreadcrumbLevel.DEBUG)); + assertTrue(backtraceBreadcrumbs.addBreadcrumb( + "post-change-error", BacktraceBreadcrumbType.MANUAL, BacktraceBreadcrumbLevel.ERROR)); + } catch (Exception ex) { + fail(ex.getMessage()); + } + } + + @Test + public void testNullMinBreadcrumbLevelDefaultsToDebug() { + try { + cleanUp(); + + backtraceBreadcrumbs = + new BacktraceBreadcrumbs(context.getFilesDir().getAbsolutePath()); + + assertTrue(backtraceBreadcrumbs.enableBreadcrumbs(context, (BacktraceBreadcrumbLevel) null)); + assertEquals(BacktraceBreadcrumbLevel.DEBUG, backtraceBreadcrumbs.getMinBreadcrumbLevel()); + + assertTrue(backtraceBreadcrumbs.addBreadcrumb( + "debug-after-null-min-level", BacktraceBreadcrumbType.MANUAL, BacktraceBreadcrumbLevel.DEBUG)); + + List breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile( + context.getFilesDir().getAbsolutePath()); + + JSONObject configBreadcrumb = new JSONObject(breadcrumbLogFileData.get(0)); + assertEquals("Breadcrumbs configuration", configBreadcrumb.get("message")); + assertEquals("debug", configBreadcrumb.getJSONObject("attributes").get("breadcrumb.level")); + + JSONObject debugBreadcrumb = new JSONObject(breadcrumbLogFileData.get(1)); + assertEquals("debug-after-null-min-level", debugBreadcrumb.get("message")); + assertEquals("debug", debugBreadcrumb.get("level")); + } catch (Exception ex) { + fail(ex.getMessage()); + } + } + + @Test + public void testNullBreadcrumbLevelDefaultsToInfo() { + try { + assertTrue(backtraceBreadcrumbs.addBreadcrumb("null-level", BacktraceBreadcrumbType.MANUAL, null)); + + List breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile( + context.getFilesDir().getAbsolutePath()); + + JSONObject parsedBreadcrumb = new JSONObject(breadcrumbLogFileData.get(1)); + assertEquals("null-level", parsedBreadcrumb.get("message")); + assertEquals("info", parsedBreadcrumb.get("level")); + } catch (Exception ex) { + fail(ex.getMessage()); + } + } + + @Test + public void testConfigurationBreadcrumbIncludesMinLevel() { + try { + cleanUp(); + + backtraceBreadcrumbs = + new BacktraceBreadcrumbs(context.getFilesDir().getAbsolutePath()); + backtraceBreadcrumbs.enableBreadcrumbs( + context, + BacktraceBreadcrumbType.ALL, + BacktraceBreadcrumbs.DEFAULT_MAX_LOG_SIZE_BYTES, + BacktraceBreadcrumbLevel.WARNING); + + List breadcrumbLogFileData = BreadcrumbsReader.readBreadcrumbLogFile( + context.getFilesDir().getAbsolutePath()); + + JSONObject configBreadcrumb = new JSONObject(breadcrumbLogFileData.get(0)); + assertEquals("Breadcrumbs configuration", configBreadcrumb.get("message")); + assertEquals("warning", configBreadcrumb.getJSONObject("attributes").get("breadcrumb.level")); + } catch (Exception ex) { + fail(ex.getMessage()); + } + } + @Test public void testAddBreadcrumbWithAttributes() { try { diff --git a/backtrace-library/src/androidTest/java/backtraceio/library/breadcrumbs/BreadcrumbsReader.java b/backtrace-library/src/androidTest/java/backtraceio/library/breadcrumbs/BreadcrumbsReader.java index 3c773e468..5c29b221a 100644 --- a/backtrace-library/src/androidTest/java/backtraceio/library/breadcrumbs/BreadcrumbsReader.java +++ b/backtrace-library/src/androidTest/java/backtraceio/library/breadcrumbs/BreadcrumbsReader.java @@ -5,32 +5,67 @@ import java.io.IOException; import java.util.ArrayList; import java.util.List; +import org.json.JSONException; +import org.json.JSONObject; +/** + * Test helper that extracts breadcrumb JSON records from the on-disk QueueFile log. + */ public class BreadcrumbsReader { + /** + * Reads the breadcrumb log file and returns each breadcrumb as a JSON string. + * + *

Lines are trimmed to their first {@code '{'}} to strip QueueFile framing bytes, + * then kept only if they parse as JSON and contain a {@code timestamp} field. This + * filters out framing noise and orphaned sub-objects exposed by rollover.

+ * + * @param path directory containing the breadcrumb log + * @return breadcrumb records in file order + */ public static List readBreadcrumbLogFile(String path) throws IOException { BacktraceBreadcrumbs breadcrumbs = new BacktraceBreadcrumbs(path); File breadcrumbLogFile = new File(breadcrumbs.getBreadcrumbLogPath()); List breadcrumbLogFileData = new ArrayList(); - FileInputStream inputStream = new FileInputStream(breadcrumbLogFile.getAbsolutePath()); - - // The encoding contains headers for the encoded data - // We just throw away lines that don't start with "timestamp - StringBuilder stringBuilder = new StringBuilder(); - while (inputStream.available() > 0) { - char c = (char) inputStream.read(); - if (c == '\n') { - String line = stringBuilder.toString(); - if (line.matches(".*timestamp.*")) { - breadcrumbLogFileData.add(line); + + try (FileInputStream inputStream = new FileInputStream(breadcrumbLogFile.getAbsolutePath())) { + StringBuilder stringBuilder = new StringBuilder(); + int readByte; + + while ((readByte = inputStream.read()) != -1) { + char c = (char) readByte; + if (c == '\n') { + addBreadcrumbJsonRecordIfValid(breadcrumbLogFileData, stringBuilder.toString()); + stringBuilder.setLength(0); + continue; } - stringBuilder = new StringBuilder(); - continue; + + stringBuilder.append(c); + } + + if (stringBuilder.length() > 0) { + addBreadcrumbJsonRecordIfValid(breadcrumbLogFileData, stringBuilder.toString()); } - stringBuilder.append(c); } return breadcrumbLogFileData; } + + private static void addBreadcrumbJsonRecordIfValid(List breadcrumbLogFileData, String line) { + int braceStart = line.indexOf('{'); + if (braceStart < 0) { + return; + } + + String candidate = line.substring(braceStart); + try { + JSONObject parsed = new JSONObject(candidate); + if (parsed.has("timestamp")) { + breadcrumbLogFileData.add(candidate); + } + } catch (JSONException ignored) { + // Ignore QueueFile framing bytes and partial rollover fragments. + } + } } diff --git a/backtrace-library/src/main/java/backtraceio/library/base/BacktraceBase.java b/backtrace-library/src/main/java/backtraceio/library/base/BacktraceBase.java index 2c69b7430..b977c9321 100644 --- a/backtrace-library/src/main/java/backtraceio/library/base/BacktraceBase.java +++ b/backtrace-library/src/main/java/backtraceio/library/base/BacktraceBase.java @@ -436,9 +436,8 @@ public boolean enableBreadcrumbs(Context context) { * @param maxBreadcrumbLogSizeBytes breadcrumb log size limit in bytes, should * be a power of 2 * @return true if we successfully enabled breadcrumbs - * @note breadcrumbTypesToEnable only affects automatic breadcrumb receivers. - * User created - * breadcrumbs will always be enabled + * @note {@code breadcrumbTypesToEnable} only affects automatic breadcrumb receivers. + * User created breadcrumbs will always be enabled */ public boolean enableBreadcrumbs(Context context, int maxBreadcrumbLogSizeBytes) { if (!isBreadcrumbsAvailable()) { @@ -454,9 +453,8 @@ public boolean enableBreadcrumbs(Context context, int maxBreadcrumbLogSizeBytes) * @param breadcrumbTypesToEnable a set containing which breadcrumb types to * enable * @return true if we successfully enabled breadcrumbs - * @note breadcrumbTypesToEnable only affects automatic breadcrumb receivers. - * User created - * breadcrumbs will always be enabled + * @note {@code breadcrumbTypesToEnable} only affects automatic breadcrumb receivers. + * User created breadcrumbs will always be enabled */ public boolean enableBreadcrumbs(Context context, EnumSet breadcrumbTypesToEnable) { if (!isBreadcrumbsAvailable()) { @@ -474,9 +472,8 @@ public boolean enableBreadcrumbs(Context context, EnumSet breadcrumbTypesToEnable, int maxBreadcrumbLogSizeBytes) { @@ -486,6 +483,110 @@ public boolean enableBreadcrumbs( return database.getBreadcrumbs().enableBreadcrumbs(context, breadcrumbTypesToEnable, maxBreadcrumbLogSizeBytes); } + /** + * Enable logging of breadcrumbs and submission with crash reports + * + * @param context context of current state of the application + * @param minBreadcrumbLevel the minimum severity level a breadcrumb must + * have to be recorded. Breadcrumbs with a level + * below this threshold will be dropped. + * @return true if we successfully enabled breadcrumbs + */ + public boolean enableBreadcrumbs(Context context, BacktraceBreadcrumbLevel minBreadcrumbLevel) { + if (!isBreadcrumbsAvailable()) { + return false; + } + return database.getBreadcrumbs().enableBreadcrumbs(context, minBreadcrumbLevel); + } + + /** + * Enable logging of breadcrumbs and submission with crash reports + * + * @param context context of current state of the application + * @param breadcrumbTypesToEnable a set containing which breadcrumb types to + * enable + * @param minBreadcrumbLevel the minimum severity level a breadcrumb + * must have to be recorded. Breadcrumbs with + * a level below this threshold will be + * dropped. + * @return true if we successfully enabled breadcrumbs + * @note {@code breadcrumbTypesToEnable} only affects automatic breadcrumb receivers. + * User created breadcrumbs will always be enabled (subject to the minBreadcrumbLevel + * threshold) + */ + public boolean enableBreadcrumbs( + Context context, + EnumSet breadcrumbTypesToEnable, + BacktraceBreadcrumbLevel minBreadcrumbLevel) { + if (!isBreadcrumbsAvailable()) { + return false; + } + return database.getBreadcrumbs().enableBreadcrumbs(context, breadcrumbTypesToEnable, minBreadcrumbLevel); + } + + /** + * Enable logging of breadcrumbs and submission with crash reports + * + * @param context context of current state of the application + * @param maxBreadcrumbLogSizeBytes breadcrumb log size limit in bytes, should + * be a power of 2 + * @param minBreadcrumbLevel the minimum severity level a breadcrumb + * must have to be recorded. Breadcrumbs + * with a level below this threshold will be + * dropped. + * @return true if we successfully enabled breadcrumbs + */ + public boolean enableBreadcrumbs( + Context context, int maxBreadcrumbLogSizeBytes, BacktraceBreadcrumbLevel minBreadcrumbLevel) { + if (!isBreadcrumbsAvailable()) { + return false; + } + return database.getBreadcrumbs().enableBreadcrumbs(context, maxBreadcrumbLogSizeBytes, minBreadcrumbLevel); + } + + /** + * Enable logging of breadcrumbs and submission with crash reports + * + * @param context context of current state of the application + * @param breadcrumbTypesToEnable a set containing which breadcrumb types to + * enable + * @param maxBreadcrumbLogSizeBytes breadcrumb log size limit in bytes, should + * be a power of 2 + * @param minBreadcrumbLevel the minimum severity level a breadcrumb + * must have to be recorded. Breadcrumbs + * with a level below this threshold will be + * dropped. + * @return true if we successfully enabled breadcrumbs + * @note {@code breadcrumbTypesToEnable} only affects automatic breadcrumb receivers. + * User created breadcrumbs will always be enabled (subject to the {@code minBreadcrumbLevel} + * threshold) + */ + public boolean enableBreadcrumbs( + Context context, + EnumSet breadcrumbTypesToEnable, + int maxBreadcrumbLogSizeBytes, + BacktraceBreadcrumbLevel minBreadcrumbLevel) { + if (!isBreadcrumbsAvailable()) { + return false; + } + return database.getBreadcrumbs() + .enableBreadcrumbs(context, breadcrumbTypesToEnable, maxBreadcrumbLogSizeBytes, minBreadcrumbLevel); + } + + /** + * Gets the current minimum breadcrumb level threshold. Breadcrumbs with a + * level below this value are dropped when the breadcrumb is added. + * + * @return the current minimum breadcrumb level, or null if breadcrumbs are + * not available + */ + public BacktraceBreadcrumbLevel getMinBreadcrumbLevel() { + if (!isBreadcrumbsAvailable()) { + return null; + } + return database.getBreadcrumbs().getMinBreadcrumbLevel(); + } + /** * Clear breadcrumb logs */ diff --git a/backtrace-library/src/main/java/backtraceio/library/breadcrumbs/BacktraceBreadcrumbs.java b/backtrace-library/src/main/java/backtraceio/library/breadcrumbs/BacktraceBreadcrumbs.java index 3e574cfe9..153f4d398 100644 --- a/backtrace-library/src/main/java/backtraceio/library/breadcrumbs/BacktraceBreadcrumbs.java +++ b/backtrace-library/src/main/java/backtraceio/library/breadcrumbs/BacktraceBreadcrumbs.java @@ -30,6 +30,13 @@ public class BacktraceBreadcrumbs implements Breadcrumbs { */ private EnumSet enabledBreadcrumbTypes; + /** + * Minimum severity level a breadcrumb must have to be recorded. Breadcrumbs with a level + * below this threshold are dropped when the breadcrumb is added. Defaults to + * {@link BacktraceBreadcrumbLevel#DEBUG} (records all levels). + */ + private BacktraceBreadcrumbLevel minBreadcrumbLevel = BacktraceBreadcrumbLevel.DEBUG; + /** * The Backtrace BroadcastReceiver instance */ @@ -145,11 +152,41 @@ public boolean enableBreadcrumbs(Context context, int maxBreadcrumbLogSizeBytes) @Override public boolean enableBreadcrumbs( Context context, EnumSet breadcrumbTypesToEnable, int maxBreadcrumbLogSizeBytes) { + return enableBreadcrumbs( + context, breadcrumbTypesToEnable, maxBreadcrumbLogSizeBytes, BacktraceBreadcrumbLevel.DEBUG); + } + + @Override + public boolean enableBreadcrumbs(Context context, BacktraceBreadcrumbLevel minBreadcrumbLevel) { + return enableBreadcrumbs(context, BacktraceBreadcrumbType.ALL, DEFAULT_MAX_LOG_SIZE_BYTES, minBreadcrumbLevel); + } + + @Override + public boolean enableBreadcrumbs( + Context context, + EnumSet breadcrumbTypesToEnable, + BacktraceBreadcrumbLevel minBreadcrumbLevel) { + return enableBreadcrumbs(context, breadcrumbTypesToEnable, DEFAULT_MAX_LOG_SIZE_BYTES, minBreadcrumbLevel); + } + + @Override + public boolean enableBreadcrumbs( + Context context, int maxBreadcrumbLogSizeBytes, BacktraceBreadcrumbLevel minBreadcrumbLevel) { + return enableBreadcrumbs(context, BacktraceBreadcrumbType.ALL, maxBreadcrumbLogSizeBytes, minBreadcrumbLevel); + } + + @Override + public boolean enableBreadcrumbs( + Context context, + EnumSet breadcrumbTypesToEnable, + int maxBreadcrumbLogSizeBytes, + BacktraceBreadcrumbLevel minBreadcrumbLevel) { this.context = context; final long startEnablingReportsTime = DebugHelper.getCurrentTimeMillis(); - final boolean enabled = enableBreadcrumbs(breadcrumbTypesToEnable, maxBreadcrumbLogSizeBytes); + final boolean enabled = + enableBreadcrumbs(breadcrumbTypesToEnable, maxBreadcrumbLogSizeBytes, minBreadcrumbLevel); final long endEnablingReportsTime = DebugHelper.getCurrentTimeMillis(); @@ -161,7 +198,9 @@ public boolean enableBreadcrumbs( } private boolean enableBreadcrumbs( - EnumSet breadcrumbTypesToEnable, int maxBreadcrumbLogSizeBytes) { + EnumSet breadcrumbTypesToEnable, + int maxBreadcrumbLogSizeBytes, + BacktraceBreadcrumbLevel minBreadcrumbLevel) { if (backtraceBreadcrumbsLogManager == null) { try { backtraceBreadcrumbsLogManager = new BacktraceBreadcrumbsLogManager( @@ -173,6 +212,7 @@ private boolean enableBreadcrumbs( } this.enabledBreadcrumbTypes = breadcrumbTypesToEnable; + this.minBreadcrumbLevel = minBreadcrumbLevel != null ? minBreadcrumbLevel : BacktraceBreadcrumbLevel.DEBUG; registerAutomaticBreadcrumbReceivers(); // We should log all breadcrumb configuration changes in the breadcrumbs @@ -185,6 +225,11 @@ public EnumSet getEnabledBreadcrumbTypes() { return this.enabledBreadcrumbTypes; } + @Override + public BacktraceBreadcrumbLevel getMinBreadcrumbLevel() { + return this.minBreadcrumbLevel; + } + @Override public boolean clearBreadcrumbs() { boolean success = backtraceBreadcrumbsLogManager.clear(); @@ -323,6 +368,12 @@ public boolean addBreadcrumb( if (!enabledBreadcrumbTypes.contains(type)) { return false; } + if (level == null) { + level = BacktraceBreadcrumbLevel.INFO; + } + if (level.ordinal() < minBreadcrumbLevel.ordinal()) { + return false; + } boolean addResult = backtraceBreadcrumbsLogManager.addBreadcrumb(message, attributes, type, level); if (addResult && this.onSuccessfulBreadcrumbAddEventListener != null) { this.onSuccessfulBreadcrumbAddEventListener.onSuccessfulAdd(this.getCurrentBreadcrumbId()); @@ -373,6 +424,8 @@ private boolean addConfigurationBreadcrumb() { attributes.put(enabledType.toString(), state); } + attributes.put("breadcrumb.level", minBreadcrumbLevel.toString()); + return backtraceBreadcrumbsLogManager.addBreadcrumb( "Breadcrumbs configuration", attributes, diff --git a/backtrace-library/src/main/java/backtraceio/library/interfaces/Breadcrumbs.java b/backtrace-library/src/main/java/backtraceio/library/interfaces/Breadcrumbs.java index 90a6d7d30..afc42c3e6 100644 --- a/backtrace-library/src/main/java/backtraceio/library/interfaces/Breadcrumbs.java +++ b/backtrace-library/src/main/java/backtraceio/library/interfaces/Breadcrumbs.java @@ -23,7 +23,7 @@ public interface Breadcrumbs { * @param context context of current state of the application * @param breadcrumbTypesToEnable a set containing which breadcrumb types to enable * @return true if we successfully enabled breadcrumbs - * @note breadcrumbTypesToEnable only affects automatic breadcrumb receivers. User created + * @note {@code breadcrumbTypesToEnable} only affects automatic breadcrumb receivers. User created * breadcrumbs will always be enabled */ boolean enableBreadcrumbs(Context context, EnumSet breadcrumbTypesToEnable); @@ -44,12 +44,101 @@ public interface Breadcrumbs { * @param breadcrumbTypesToEnable a set containing which breadcrumb types to enable * @param maxBreadcrumbLogSizeBytes breadcrumb log size limit in bytes, should be a power of 2 * @return true if we successfully enabled breadcrumbs - * @note breadcrumbTypesToEnable only affects automatic breadcrumb receivers. User created + * @note {@code breadcrumbTypesToEnable} only affects automatic breadcrumb receivers. User created * breadcrumbs will always be enabled */ boolean enableBreadcrumbs( Context context, EnumSet breadcrumbTypesToEnable, int maxBreadcrumbLogSizeBytes); + /** + * Enable logging of breadcrumbs and submission with crash reports + * + * @param context context of current state of the application + * @param minBreadcrumbLevel the minimum severity level a breadcrumb must have to be recorded. + * Breadcrumbs with a level below this threshold will be dropped. + * Use {@link BacktraceBreadcrumbLevel#DEBUG} to record all levels. + * A {@code null} value is treated as {@link BacktraceBreadcrumbLevel#DEBUG}. + * @return true if we successfully enabled breadcrumbs + * + *

Default implementation: delegates to {@link #enableBreadcrumbs(Context)} + * to preserve compatibility with existing implementations. Implementations must override this method to apply {@code minBreadcrumbLevel} filtering.

+ */ + default boolean enableBreadcrumbs(Context context, BacktraceBreadcrumbLevel minBreadcrumbLevel) { + return enableBreadcrumbs(context); + } + + /** + * Enable logging of breadcrumbs and submission with crash reports + * + * @param context context of current state of the application + * @param breadcrumbTypesToEnable a set containing which breadcrumb types to enable + * @param minBreadcrumbLevel the minimum severity level a breadcrumb must have to be recorded. + * Breadcrumbs with a level below this threshold will be dropped. + * Use {@link BacktraceBreadcrumbLevel#DEBUG} to record all levels. + * A {@code null} value is treated as {@link BacktraceBreadcrumbLevel#DEBUG}. + * @return true if we successfully enabled breadcrumbs + * @note {@code breadcrumbTypesToEnable} only affects automatic breadcrumb receivers. User created + * breadcrumbs will always be enabled (subject to the {@code minBreadcrumbLevel} threshold) + * + *

Default implementation: delegates to + * {@link #enableBreadcrumbs(Context, EnumSet)} to preserve compatibility with existing implementations. + * Implementations must override this method to apply {@code minBreadcrumbLevel} filtering.

+ */ + default boolean enableBreadcrumbs( + Context context, + EnumSet breadcrumbTypesToEnable, + BacktraceBreadcrumbLevel minBreadcrumbLevel) { + return enableBreadcrumbs(context, breadcrumbTypesToEnable); + } + + /** + * Enable logging of breadcrumbs and submission with crash reports + * + * @param context context of current state of the application + * @param maxBreadcrumbLogSizeBytes breadcrumb log size limit in bytes, should be a power of 2 + * @param minBreadcrumbLevel the minimum severity level a breadcrumb must have to be recorded. + * Breadcrumbs with a level below this threshold will be dropped. + * Use {@link BacktraceBreadcrumbLevel#DEBUG} to record all levels. + * A {@code null} value is treated as {@link BacktraceBreadcrumbLevel#DEBUG}. + * @return true if we successfully enabled breadcrumbs + * + *

Default implementation: delegates to + * {@link #enableBreadcrumbs(Context, int)} to preserve compatibility with existing implementations. + * Implementations must override this method to apply + * {@code minBreadcrumbLevel} filtering.

+ */ + default boolean enableBreadcrumbs( + Context context, int maxBreadcrumbLogSizeBytes, BacktraceBreadcrumbLevel minBreadcrumbLevel) { + return enableBreadcrumbs(context, maxBreadcrumbLogSizeBytes); + } + + /** + * Enable logging of breadcrumbs and submission with crash reports + * + * @param context context of current state of the application + * @param breadcrumbTypesToEnable a set containing which breadcrumb types to enable + * @param maxBreadcrumbLogSizeBytes breadcrumb log size limit in bytes, should be a power of 2 + * @param minBreadcrumbLevel the minimum severity level a breadcrumb must have to be recorded. + * Breadcrumbs with a level below this threshold will be dropped. + * Use {@link BacktraceBreadcrumbLevel#DEBUG} to record all levels. + * A {@code null} value is treated as {@link BacktraceBreadcrumbLevel#DEBUG}. + * @return true if we successfully enabled breadcrumbs + * @note {@code breadcrumbTypesToEnable} only affects automatic breadcrumb receivers. User created + * breadcrumbs will always be enabled (subject to the {@code minBreadcrumbLevel} threshold) + * + *

Default implementation: delegates to + * {@link #enableBreadcrumbs(Context, EnumSet, int)} to preserve compatibility with existing implementations. + * Implementations must override this method to apply + * {@code minBreadcrumbLevel} filtering.

+ */ + default boolean enableBreadcrumbs( + Context context, + EnumSet breadcrumbTypesToEnable, + int maxBreadcrumbLogSizeBytes, + BacktraceBreadcrumbLevel minBreadcrumbLevel) { + return enableBreadcrumbs(context, breadcrumbTypesToEnable, maxBreadcrumbLogSizeBytes); + } + /** * Gets the enabled breadcrumb types * @@ -57,6 +146,19 @@ boolean enableBreadcrumbs( */ EnumSet getEnabledBreadcrumbTypes(); + /** + * Gets the current minimum breadcrumb level threshold. Breadcrumbs with a level below this + * value are dropped when the breadcrumb is added. + * + * @return the current minimum breadcrumb level + * + *

Default implementation: returns {@link BacktraceBreadcrumbLevel#DEBUG}, + * which preserves the existing behavior of recording all breadcrumb levels.

+ */ + default BacktraceBreadcrumbLevel getMinBreadcrumbLevel() { + return BacktraceBreadcrumbLevel.DEBUG; + } + /** * Clear breadcrumb logs * @@ -76,7 +178,7 @@ boolean enableBreadcrumbs( * Add a breadcrumb of type "Manual" and the desired level with the provided message string * * @param message a message which describes this breadcrumb (1KB max) - * @param level the severity level of this breadcrumb + * @param level the severity level of this breadcrumb ({@code null} is treated as {@link BacktraceBreadcrumbLevel#INFO}) * @return true if the breadcrumb was successfully added */ boolean addBreadcrumb(String message, BacktraceBreadcrumbLevel level); @@ -95,7 +197,7 @@ boolean enableBreadcrumbs( * * @param message a message which describes this breadcrumb (1KB max) * @param attributes key-value pairs to provide additional information about this breadcrumb (1KB max, including some overhead per key-value pair) - * @param level the severity level of this breadcrumb + * @param level the severity level of this breadcrumb ({@code null} is treated as {@link BacktraceBreadcrumbLevel#INFO}) * @return true if the breadcrumb was successfully added */ boolean addBreadcrumb(String message, Map attributes, BacktraceBreadcrumbLevel level); @@ -114,7 +216,7 @@ boolean enableBreadcrumbs( * * @param message a message which describes this breadcrumb (1KB max) * @param type broadly describes the category of this breadcrumb - * @param level the severity level of this breadcrumb + * @param level the severity level of this breadcrumb ({@code null} is treated as {@link BacktraceBreadcrumbLevel#INFO}) * @return true if the breadcrumb was successfully added */ boolean addBreadcrumb(String message, BacktraceBreadcrumbType type, BacktraceBreadcrumbLevel level); @@ -135,7 +237,7 @@ boolean enableBreadcrumbs( * @param message a message which describes this breadcrumb (1KB max) * @param attributes key-value pairs to provide additional information about this breadcrumb (1KB max, including some overhead per key-value pair) * @param type broadly describes the category of this breadcrumb - * @param level the severity level of this breadcrumb + * @param level the severity level of this breadcrumb ({@code null} is treated as {@link BacktraceBreadcrumbLevel#INFO}) * @return true if the breadcrumb was successfully added */ boolean addBreadcrumb( diff --git a/example-app/src/main/java/backtraceio/backtraceio/MainActivity.java b/example-app/src/main/java/backtraceio/backtraceio/MainActivity.java index 11cd05471..ef36f7bfc 100644 --- a/example-app/src/main/java/backtraceio/backtraceio/MainActivity.java +++ b/example-app/src/main/java/backtraceio/backtraceio/MainActivity.java @@ -11,6 +11,7 @@ import backtraceio.library.BacktraceCredentials; import backtraceio.library.BacktraceDatabase; import backtraceio.library.base.BacktraceBase; +import backtraceio.library.enums.BacktraceBreadcrumbLevel; import backtraceio.library.enums.BacktraceBreadcrumbType; import backtraceio.library.enums.database.RetryBehavior; import backtraceio.library.enums.database.RetryOrder; @@ -186,7 +187,8 @@ public void enableBreadcrumbs(View view) throws Exception { throw new Exception("App context is null"); } - backtraceClient.enableBreadcrumbs(view.getContext().getApplicationContext()); + // NOTE: Minimum breadcrumb level set to INFO (DEBUG breadcrumbs will be filtered out) + backtraceClient.enableBreadcrumbs(view.getContext().getApplicationContext(), BacktraceBreadcrumbLevel.INFO); registerNativeBreadcrumbs(backtraceClient); // Order should not matter } @@ -205,6 +207,22 @@ public void sendReport(View view) { } }; backtraceClient.addBreadcrumb("About to send Backtrace report", attributes, BacktraceBreadcrumbType.LOG); + backtraceClient.addBreadcrumb( + "Debug breadcrumb (< INFO, filtered)", + attributes, + BacktraceBreadcrumbType.LOG, + BacktraceBreadcrumbLevel.DEBUG); + backtraceClient.addBreadcrumb( + "Info breadcrumb (== INFO)", attributes, BacktraceBreadcrumbType.LOG, BacktraceBreadcrumbLevel.INFO); + backtraceClient.addBreadcrumb( + "Warning breadcrumb (> INFO)", + attributes, + BacktraceBreadcrumbType.LOG, + BacktraceBreadcrumbLevel.WARNING); + backtraceClient.addBreadcrumb( + "Error breadcrumb (> INFO)", attributes, BacktraceBreadcrumbType.LOG, BacktraceBreadcrumbLevel.ERROR); + backtraceClient.addBreadcrumb( + "Fatal breadcrumb (> INFO)", attributes, BacktraceBreadcrumbType.LOG, BacktraceBreadcrumbLevel.FATAL); addNativeBreadcrumb(); addNativeBreadcrumbUserError(); BacktraceReport report = new BacktraceReport("Test");