Feat/add ignore transactions and ignore errors #1391

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog
 
 ## Unreleased 
+- Add ignoreTransactions and ignoreErrors to options ([#1391](https://github.com/getsentry/sentry-dart/issues/1391)) ([#2207](https://github.com/getsentry/sentry-dart/pull/2207))
 
 ### Improvements
 

dart/lib/src/sentry_client.dart

@@ -84,6 +84,16 @@ class SentryClient {
     dynamic stackTrace,
     Hint? hint,
   }) async {
+    if (_isIgnoredError(event)) {
+      _options.logger(
+        SentryLevel.debug,
+        'Error was ignored as specified in the ignoredErrors options.',
+      );
+      _options.recorder
+          .recordLostEvent(DiscardReason.ignored, _getCategory(event));
+      return _emptySentryId;
+    }
+
     if (_options.containsIgnoredExceptionForType(event.throwable)) {
       _options.logger(
         SentryLevel.debug,
@@ -180,6 +190,21 @@ class SentryClient {
     return id ?? SentryId.empty();
   }
 
+  bool _isIgnoredError(SentryEvent event) {
+    if (_options.ignoreErrors == null ||
+        _options.ignoreErrors!.isEmpty ||
+        event.message == null) {
+      return false;
+    }
+    String combinedRegexPattern = _options.ignoreErrors!.join('|');
+
+    RegExp regExp = RegExp(combinedRegexPattern);
+
+    bool ignore = regExp.firstMatch(event.message!.formatted) != null;
+
+    return ignore;
+  }
+
   SentryEvent _prepareEvent(SentryEvent event, {dynamic stackTrace}) {
     event = event.copyWith(
       serverName: event.serverName ?? _options.serverName,
@@ -351,6 +376,17 @@ class SentryClient {
       return _emptySentryId;
     }
 
+    if (_isIgnoredTransaction(preparedTransaction)) {
+      _options.logger(
+        SentryLevel.debug,
+        'Transaction was ignored as specified in the ignoredTransactions options.',
+      );
+
+      _options.recorder.recordLostEvent(
+          DiscardReason.ignored, _getCategory(preparedTransaction));
+      return _emptySentryId;
+    }
+
     preparedTransaction =
         await _runBeforeSend(preparedTransaction, hint) as SentryTransaction?;
 
@@ -379,6 +415,21 @@ class SentryClient {
     return id ?? SentryId.empty();
   }
 
+  bool _isIgnoredTransaction(SentryTransaction transaction) {
+    if (_options.ignoreTransactions == null ||
+        _options.ignoreTransactions!.isEmpty) {
+      return false;
+    }
+
+    String combinedRegexPattern = _options.ignoreTransactions!.join('|');
+
+    RegExp regExp = RegExp(combinedRegexPattern);
+
+    bool ignore = regExp.firstMatch(transaction.tracer.name) != null;
+
+    return ignore;
+  }
+
   /// Reports the [envelope] to Sentry.io.
   Future<SentryId?> captureEnvelope(SentryEnvelope envelope) {
     return _attachClientReportsAndSend(envelope);

dart/lib/src/sentry_options.dart

@@ -184,6 +184,14 @@ class SentryOptions {
   /// sent. Events are picked randomly. Default is null (disabled)
   double? sampleRate;
 
+  /// The ignoreErrors tells the SDK which errors should be not sent to the sentry server.
+  /// If an null or an empty list is used, the SDK will send all transactions.
+  List<String>? ignoreErrors;
+
+  /// The ignoreTransactions tells the SDK which transactions should be not sent to the sentry server.
+  /// If null or an empty list is used, the SDK will send all transactions.
+  List<String>? ignoreTransactions;
+
   final List<String> _inAppExcludes = [];
 
   /// A list of string prefixes of packages names that do not belong to the app, but rather third-party

dart/test/sentry_client_test.dart

@@ -1033,6 +1033,97 @@ void main() {
     });
   });
 
+  group('SentryClient ignored errors', () {
+    late Fixture fixture;
+
+    setUp(() {
+      fixture = Fixture();
+      fixture.options.ignoreErrors = ["my-error", "error-.*"];
+    });
+
+    test('ignore Error "my-error"', () async {
+      final event = SentryEvent(message: SentryMessage("my-error"));
+
+      final client = fixture.getSut();
+      await client.captureEvent(event);
+
+      expect((fixture.transport).called(0), true);
+    });
+
+    test('ignore Error "error-foo"', () async {
+      final event = SentryEvent(message: SentryMessage("error-foo"));
+
+      final client = fixture.getSut();
+      await client.captureEvent(event);
+
+      expect((fixture.transport).called(0), true);
+    });
+
+    test('allow Error "warning"', () async {
+      final event = SentryEvent(message: SentryMessage("warning"));
+
+      final client = fixture.getSut();
+      await client.captureEvent(event);
+
+      expect((fixture.transport).called(1), true);
+    });
+
+    test('allow Error "partially matching my-error"', () async {
+      final event =
+          SentryEvent(message: SentryMessage("partially matching my-error"));
+
+      final client = fixture.getSut();
+      await client.captureEvent(event);
+
+      expect((fixture.transport).called(1), true);
+    });
+  });
+
+  group('SentryClient ignored transactions', () {
+    late Fixture fixture;
+
+    setUp(() {
+      fixture = Fixture();
+      fixture.options.ignoreTransactions = ["my-transaction", "transaction-.*"];
+    });
+
+    test('ignore Transaction "my-transaction"', () async {
+      final client = fixture.getSut();
+      final fakeTransaction = fixture.fakeTransaction();
+      fakeTransaction.tracer.name = "my-transaction";
+      await client.captureTransaction(fakeTransaction);
+
+      expect((fixture.transport).called(0), true);
+    });
+
+    test('ignore Transaction "transaction-foo"', () async {
+      final client = fixture.getSut();
+      final fakeTransaction = fixture.fakeTransaction();
+      fakeTransaction.tracer.name = "transaction-foo";
+      await client.captureTransaction(fakeTransaction);
+
+      expect((fixture.transport).called(0), true);
+    });
+
+    test('allow Transaction "capture"', () async {
+      final client = fixture.getSut();
+      final fakeTransaction = fixture.fakeTransaction();
+      fakeTransaction.tracer.name = "capture";
+      await client.captureTransaction(fakeTransaction);
+
+      expect((fixture.transport).called(1), true);
+    });
+
+    test('allow Transaction "partially matching my-transaction"', () async {
+      final client = fixture.getSut();
+      final fakeTransaction = fixture.fakeTransaction();
+      fakeTransaction.tracer.name = "partially matching my-transaction";
+      await client.captureTransaction(fakeTransaction);
+
+      expect((fixture.transport).called(1), true);
+    });
+  });
+
   group('SentryClient ignored exceptions', () {
     late Fixture fixture;