Record dropped spans

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+- Record dropped spans (#4172)
+
 ## 8.31.1
 
 ### Fixes

SentryTestUtils/Invocations.swift

@@ -41,6 +41,15 @@
         }
     }
 
+    public func get(_ index: Int) -> T? {
+        return queue.sync {
+            guard self._invocations.indices.contains(index) else {
+                return nil
+            }
+            return self._invocations[index]
+        }
+    }
+
     public func record(_ invocation: T) {
         queue.async {
             self._invocations.append(invocation)

SentryTestUtils/TestClient.swift

@@ -127,6 +127,11 @@ public class TestClient: SentryClient {
         recordLostEvents.record((category, reason))
     }
 
+    public var recordLostEventsWithQauntity = Invocations<(category: SentryDataCategory, reason: SentryDiscardReason, quantity: UInt)>()
+    public override func recordLostEvent(_ category: SentryDataCategory, reason: SentryDiscardReason, quantity: UInt) {
+        recordLostEventsWithQauntity.record((category, reason, quantity))
+    }
+
     public var flushInvocations = Invocations<TimeInterval>()
     public override func flush(timeout: TimeInterval) {
         flushInvocations.record(timeout)

SentryTestUtils/TestTransport.swift

@@ -13,6 +13,11 @@ public class TestTransport: NSObject, Transport {
         recordLostEvents.record((category, reason))
     }
 
+    public var recordLostEventsWithCount = Invocations<(category: SentryDataCategory, reason: SentryDiscardReason, quantity: UInt)>()
+    public func recordLostEvent(_ category: SentryDataCategory, reason: SentryDiscardReason, quantity: UInt) {
+        recordLostEventsWithCount.record((category, reason, quantity))
+    }
+
     public var flushInvocations = Invocations<TimeInterval>()
     public func flush(_ timeout: TimeInterval) -> SentryFlushResult {
         flushInvocations.record(timeout)

Sources/Sentry/SentryClient.m

@@ -571,6 +571,13 @@ - (void)recordLostEvent:(SentryDataCategory)category reason:(SentryDiscardReason
     [self.transportAdapter recordLostEvent:category reason:reason];
 }
 
+- (void)recordLostEvent:(SentryDataCategory)category
+                 reason:(SentryDiscardReason)reason
+               quantity:(NSUInteger)quantity
+{
+    [self.transportAdapter recordLostEvent:category reason:reason quantity:quantity];
+}
+
 - (SentryEvent *_Nullable)prepareEvent:(SentryEvent *)event
                              withScope:(SentryScope *)scope
                 alwaysAttachStacktrace:(BOOL)alwaysAttachStacktrace
@@ -719,13 +726,35 @@ - (SentryEvent *_Nullable)prepareEvent:(SentryEvent *)event
         event.user.ipAddress = @"{{auto}}";
     }
 
+    BOOL eventIsATransaction
+        = event.type != nil && [event.type isEqualToString:SentryEnvelopeItemTypeTransaction];
+    BOOL eventIsATransactionClass
+        = eventIsATransaction && [event isKindOfClass:[SentryTransaction class]];
+
+    NSUInteger currentSpanCount;
+    if (eventIsATransactionClass) {
+        SentryTransaction *transaction = (SentryTransaction *)event;
+        currentSpanCount = transaction.spans.count;
+    } else {
+        currentSpanCount = 0;
+    }
+
     event = [self callEventProcessors:event];
     if (event == nil) {
         [self recordLost:eventIsNotATransaction reason:kSentryDiscardReasonEventProcessor];
+        if (eventIsATransaction) {
+            // We dropped the whole transaction, the dropped count includes all child spans + 1 root
+            // span
+            [self recordLostSpanWithReason:kSentryDiscardReasonEventProcessor
+                                  quantity:currentSpanCount + 1];
+        }
+    } else {
+        if (eventIsATransactionClass) {
+            [self recordPartiallyDroppedSpans:(SentryTransaction *)event
+                                   withReason:kSentryDiscardReasonEventProcessor
+                         withCurrentSpanCount:&currentSpanCount];
+        }
     }
-
-    BOOL eventIsATransaction
-        = event.type != nil && [event.type isEqualToString:SentryEnvelopeItemTypeTransaction];
     if (event != nil && eventIsATransaction && self.options.beforeSendSpan != nil) {
         SentryTransaction *transaction = (SentryTransaction *)event;
         NSMutableArray<id<SentrySpan>> *processedSpans = [NSMutableArray array];
@@ -735,15 +764,31 @@ - (SentryEvent *_Nullable)prepareEvent:(SentryEvent *)event
                 [processedSpans addObject:processedSpan];
             }
         }
-
         transaction.spans = processedSpans;
+
+        if (eventIsATransactionClass) {
+            [self recordPartiallyDroppedSpans:transaction
+                                   withReason:kSentryDiscardReasonBeforeSend
+                         withCurrentSpanCount:&currentSpanCount];
+        }
     }
 
     if (event != nil && nil != self.options.beforeSend) {
         event = self.options.beforeSend(event);
-
         if (event == nil) {
             [self recordLost:eventIsNotATransaction reason:kSentryDiscardReasonBeforeSend];
+            if (eventIsATransaction) {
+                // We dropped the whole transaction, the dropped count includes all child spans + 1
+                // root span
+                [self recordLostSpanWithReason:kSentryDiscardReasonBeforeSend
+                                      quantity:currentSpanCount + 1];
+            }
+        } else {
+            if (eventIsATransactionClass) {
+                [self recordPartiallyDroppedSpans:(SentryTransaction *)event
+                                       withReason:kSentryDiscardReasonBeforeSend
+                             withCurrentSpanCount:&currentSpanCount];
+            }
         }
     }
 
@@ -758,6 +803,19 @@ - (SentryEvent *_Nullable)prepareEvent:(SentryEvent *)event
     return event;
 }
 
+- (void)recordPartiallyDroppedSpans:(SentryTransaction *)transaction
+                         withReason:(SentryDiscardReason)reason
+               withCurrentSpanCount:(NSUInteger *)currentSpanCount
+{
+    // If some spans got removed we still report them as dropped
+    NSUInteger spanCountAfter = transaction.spans.count;
+    NSUInteger droppedSpanCount = *currentSpanCount - spanCountAfter;
+    if (droppedSpanCount > 0) {
+        [self recordLostSpanWithReason:reason quantity:droppedSpanCount];
+    }
+    *currentSpanCount = spanCountAfter;
+}
+
 - (BOOL)isSampled:(NSNumber *)sampleRate
 {
     if (sampleRate == nil) {
@@ -971,6 +1029,11 @@ - (void)recordLost:(BOOL)eventIsNotATransaction reason:(SentryDiscardReason)reas
     }
 }
 
+- (void)recordLostSpanWithReason:(SentryDiscardReason)reason quantity:(NSUInteger)quantity
+{
+    [self recordLostEvent:kSentryDataCategorySpan reason:reason quantity:quantity];
+}
+
 - (void)addAttachmentProcessor:(id<SentryClientAttachmentProcessor>)attachmentProcessor
 {
     [self.attachmentProcessors addObject:attachmentProcessor];

Sources/Sentry/SentryDataCategoryMapper.m

@@ -14,6 +14,7 @@
 NSString *const kSentryDataCategoryNameProfileChunk = @"profile_chunk";
 NSString *const kSentryDataCategoryNameReplay = @"replay";
 NSString *const kSentryDataCategoryNameMetricBucket = @"metric_bucket";
+NSString *const kSentryDataCategoryNameSpan = @"span";
 NSString *const kSentryDataCategoryNameUnknown = @"unknown";
 
 NS_ASSUME_NONNULL_BEGIN
@@ -47,6 +48,7 @@
     if ([itemType isEqualToString:SentryEnvelopeItemTypeStatsd]) {
         return kSentryDataCategoryMetricBucket;
     }
+
     return kSentryDataCategoryDefault;
 }
 
@@ -96,6 +98,9 @@
     if ([value isEqualToString:kSentryDataCategoryNameMetricBucket]) {
         return kSentryDataCategoryMetricBucket;
     }
+    if ([value isEqualToString:kSentryDataCategoryNameSpan]) {
+        return kSentryDataCategorySpan;
+    }
 
     return kSentryDataCategoryUnknown;
 }
@@ -132,6 +137,8 @@
         return kSentryDataCategoryNameUnknown;
     case kSentryDataCategoryReplay:
         return kSentryDataCategoryNameReplay;
+    case kSentryDataCategorySpan:
+        return kSentryDataCategoryNameSpan;
     }
 }
 

Sources/Sentry/SentryEnvelopeRateLimit.m

@@ -59,7 +59,7 @@ - (SentryEnvelope *)removeRateLimitedItems:(SentryEnvelope *)envelope
             = sentryDataCategoryForEnvelopItemType(item.header.type);
         if ([self.rateLimits isRateLimitActive:rateLimitCategory]) {
             [itemsToDrop addObject:item];
-            [self.delegate envelopeItemDropped:rateLimitCategory];
+            [self.delegate envelopeItemDropped:item withCategory:rateLimitCategory];
         }
     }
 

Sources/Sentry/SentryFileManager.m

@@ -365,7 +365,7 @@ - (void)handleEnvelopesLimit
                 continue;
             }
 
-            [_delegate envelopeItemDeleted:rateLimitCategory];
+            [_delegate envelopeItemDeleted:item withCategory:rateLimitCategory];
         }
 
         [self removeFileAtPath:envelopeFilePath];

Sources/Sentry/SentryHttpTransport.m

@@ -1,5 +1,6 @@
 #import "SentryHttpTransport.h"
 #import "SentryClientReport.h"
+#import "SentryDataCategory.h"
 #import "SentryDataCategoryMapper.h"
 #import "SentryDependencyContainer.h"
 #import "SentryDiscardReasonMapper.h"
@@ -139,6 +140,13 @@
 }
 
 - (void)recordLostEvent:(SentryDataCategory)category reason:(SentryDiscardReason)reason
+{
+    [self recordLostEvent:category reason:reason quantity:1];
+}
+
+- (void)recordLostEvent:(SentryDataCategory)category
+                 reason:(SentryDiscardReason)reason
+               quantity:(NSUInteger)quantity
 {
     if (!self.options.sendClientReports) {
         return;
@@ -149,7 +157,6 @@
 
     @synchronized(self.discardedEvents) {
         SentryDiscardedEvent *event = self.discardedEvents[key];
-        NSUInteger quantity = 1;
         if (event != nil) {
             quantity = event.quantity + 1;
         }
@@ -225,17 +232,21 @@
 /**
  * SentryEnvelopeRateLimitDelegate.
  */
-- (void)envelopeItemDropped:(SentryDataCategory)dataCategory
+- (void)envelopeItemDropped:(SentryEnvelopeItem *)envelopeItem
+               withCategory:(SentryDataCategory)dataCategory;
 {
     [self recordLostEvent:dataCategory reason:kSentryDiscardReasonRateLimitBackoff];
+    [self recordLostSpans:envelopeItem reason:kSentryDiscardReasonRateLimitBackoff];
 }
 
 /**
  * SentryFileManagerDelegate.
  */
-- (void)envelopeItemDeleted:(SentryDataCategory)dataCategory
+- (void)envelopeItemDeleted:(SentryEnvelopeItem *)envelopeItem
+               withCategory:(SentryDataCategory)dataCategory
 {
     [self recordLostEvent:dataCategory reason:kSentryDiscardReasonCacheOverflow];
+    [self recordLostSpans:envelopeItem reason:kSentryDiscardReasonCacheOverflow];
 }
 
 #pragma mark private methods
@@ -389,6 +400,23 @@
         }
         SentryDataCategory category = sentryDataCategoryForEnvelopItemType(itemType);
         [self recordLostEvent:category reason:kSentryDiscardReasonNetworkError];
+        [self recordLostSpans:item reason:kSentryDiscardReasonNetworkError];
+    }
+}
+
+- (void)recordLostSpans:(SentryEnvelopeItem *)envelopeItem reason:(SentryDiscardReason)reason
+{
+    if ([SentryEnvelopeItemTypeTransaction isEqualToString:envelopeItem.header.type]) {
+        NSDictionary *transactionJson =
+            [SentrySerialization deserializeEventEnvelopeItem:envelopeItem.data];
+        if (transactionJson == nil) {
+            return;
+        }
+        NSArray *spans = transactionJson[@"spans"];
+        if (spans == nil) {
+            spans = [NSArray new];
+        }
+        [self recordLostEvent:kSentryDataCategorySpan reason:reason quantity:spans.count + 1];
     }
 }
 

Sources/Sentry/SentryHub.m

@@ -285,6 +285,9 @@ - (void)captureTransaction:(SentryTransaction *)transaction
     if (decision != kSentrySampleDecisionYes) {
         [self.client recordLostEvent:kSentryDataCategoryTransaction
                               reason:kSentryDiscardReasonSampleRate];
+        [self.client recordLostEvent:kSentryDataCategorySpan
+                              reason:kSentryDiscardReasonSampleRate
+                            quantity:transaction.spans.count + 1];
         return;
     }
 

Sources/Sentry/SentrySpotlightTransport.m

@@ -96,11 +96,19 @@ - (void)recordLostEvent:(SentryDataCategory)category reason:(SentryDiscardReason
     // Empty on purpose
 }
 
+- (void)recordLostEvent:(SentryDataCategory)category
+                 reason:(SentryDiscardReason)reason
+               quantity:(NSUInteger)quantity
+{
+    // Empty on purpose
+}
+
 #if defined(TEST) || defined(TESTCI) || defined(DEBUG)
 - (void)setStartFlushCallback:(nonnull void (^)(void))callback
 {
     // Empty on purpose
 }
+
 #endif // defined(TEST) || defined(TESTCI) || defined(DEBUG)
 
 @end

Sources/Sentry/SentryTransportAdapter.m

@@ -102,6 +102,15 @@ - (void)recordLostEvent:(SentryDataCategory)category reason:(SentryDiscardReason
     }
 }
 
+- (void)recordLostEvent:(SentryDataCategory)category
+                 reason:(SentryDiscardReason)reason
+               quantity:(NSUInteger)quantity
+{
+    for (id<SentryTransport> transport in self.transports) {
+        [transport recordLostEvent:category reason:reason quantity:quantity];
+    }
+}
+
 - (void)flush:(NSTimeInterval)timeout
 {
     for (id<SentryTransport> transport in self.transports) {

Sources/Sentry/include/SentryClient+Private.h

@@ -57,6 +57,9 @@ SentryClient ()
 - (void)captureEnvelope:(SentryEnvelope *)envelope;
 
 - (void)recordLostEvent:(SentryDataCategory)category reason:(SentryDiscardReason)reason;
+- (void)recordLostEvent:(SentryDataCategory)category
+                 reason:(SentryDiscardReason)reason
+               quantity:(NSUInteger)quantity;
 
 - (void)addAttachmentProcessor:(id<SentryClientAttachmentProcessor>)attachmentProcessor;
 - (void)removeAttachmentProcessor:(id<SentryClientAttachmentProcessor>)attachmentProcessor;

Sources/Sentry/include/SentryDataCategory.h

@@ -17,5 +17,6 @@ typedef NS_ENUM(NSUInteger, SentryDataCategory) {
     kSentryDataCategoryMetricBucket = 8,
     kSentryDataCategoryReplay = 9,
     kSentryDataCategoryProfileChunk = 10,
-    kSentryDataCategoryUnknown = 11
+    kSentryDataCategorySpan = 11,
+    kSentryDataCategoryUnknown = 12,
 };

Sources/Sentry/include/SentryDataCategoryMapper.h

@@ -14,6 +14,7 @@ FOUNDATION_EXPORT NSString *const kSentryDataCategoryNameProfile;
 FOUNDATION_EXPORT NSString *const kSentryDataCategoryNameProfileChunk;
 FOUNDATION_EXPORT NSString *const kSentryDataCategoryNameReplay;
 FOUNDATION_EXPORT NSString *const kSentryDataCategoryNameMetricBucket;
+FOUNDATION_EXPORT NSString *const kSentryDataCategoryNameSpan;
 FOUNDATION_EXPORT NSString *const kSentryDataCategoryNameUnknown;
 
 SentryDataCategory sentryDataCategoryForNSUInteger(NSUInteger value);

Sources/Sentry/include/SentryEnvelopeRateLimit.h

@@ -3,7 +3,7 @@
 
 @protocol SentryEnvelopeRateLimitDelegate;
 
-@class SentryEnvelope;
+@class SentryEnvelope, SentryEnvelopeItem;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -23,7 +23,8 @@ NS_SWIFT_NAME(EnvelopeRateLimit)
 
 @protocol SentryEnvelopeRateLimitDelegate <NSObject>
 
-- (void)envelopeItemDropped:(SentryDataCategory)dataCategory;
+- (void)envelopeItemDropped:(SentryEnvelopeItem *)envelopeItem
+               withCategory:(SentryDataCategory)dataCategory;
 
 @end