feature: NR-455916 errored session sample

Agent/Analytics/PersistentEventStore.m

@@ -88,7 +88,7 @@ - (void)setObject:(nonnull id)object forKey:(nonnull id)key {
        // NRLOG_AUDIT(@"Entered block");
         @synchronized (self) {
             if(!self->_dirty) {
-                NRLOG_AUDIT(@"Not writing file because it's not dirty");
+                NRLOG_AGENT_DEBUG(@"Not writing file because it's not dirty");
                 return;
             }
         }
@@ -108,7 +108,7 @@ - (void)removeObjectForKey:(id)key {
        // NRLOG_AGENT_VERBOSE(@"Entered Remove Block");
         @synchronized (self) {
             if(!self->_dirty) {
-                NRLOG_AGENT_VERBOSE(@"Not writing removed item file because it's not dirty");
+                NRLOG_AGENT_DEBUG(@"Not writing removed item file because it's not dirty");
                 return;
             }
         }
@@ -132,7 +132,7 @@ - (void)clearAll {
        // NRLOG_AGENT_VERBOSE(@"Entered Clear Block");
         @synchronized (self) {
             if(!self->_dirty) {
-              //  NRLOG_AGENT_VERBOSE(@"Not writing cleared file because it's not dirty");
+              //  NRLOG_AGENT_DEBUG(@"Not writing cleared file because it's not dirty");
                 return;
             }
         }
@@ -182,7 +182,7 @@ - (void)saveToFile {
                                      options:NSDataWritingAtomic
                                        error:&error];
         if(!success) {
-            NRLOG_AGENT_ERROR(@"Error saving data: %@", error.description);
+            NRLOG_AGENT_DEBUG(@"Error saving data: %@", error.description);
         } else {
            // NRLOG_AUDIT(@"Wrote file");
             _lastSave = [NSDate new];

Agent/General/NewRelicAgentInternal.h

@@ -92,6 +92,7 @@ NS_ASSUME_NONNULL_BEGIN
 - (void) sessionReplayEndSession;
 
 - (BOOL) isSessionReplaySampled;
+- (BOOL) isSessionReplayErrorSampled;
 
 - (BOOL) isSessionReplayEnabled;
 
@@ -124,6 +125,8 @@ NS_ASSUME_NONNULL_BEGIN
 
 // Pause a session replay recording
 - (BOOL) pauseReplay;
+// Notify Session Replay of an error
+- (void)sessionReplayOnError:(NSError *_Nullable)error;
 
 // END SESSION REPLAY SECTION Methods to start and pause SessionReplay
 

Agent/General/NewRelicAgentInternal.m

@@ -358,6 +358,7 @@ - (void) initialize {
     }
 #endif
 #if !TARGET_OS_TV && !TARGET_OS_WATCH
+    // SESSION REPLAY INITIALIZATION
     if (@available(iOS 13.0, *)) {
         SessionReplayReporter *reporter = [[SessionReplayReporter alloc] initWithApplicationToken:_agentConfiguration.applicationToken.value url: [self->_agentConfiguration sessionReplayURL]];
         _sessionReplay = [[SessionReplayManager alloc] initWithReporter:reporter url: [self->_agentConfiguration sessionReplayURL]];
@@ -366,6 +367,9 @@ - (void) initialize {
             [_sessionReplay checkForPreviousSessionFiles];
         }
     }
+
+    // END SESSION REPLAY INITIALIZATION
+
 #endif
 }
 
@@ -616,22 +620,39 @@ - (void) onSessionStart {
 
 - (void) sessionReplayEndSession {
 #if !TARGET_OS_TV && !TARGET_OS_WATCH
-    BOOL isSampled = [self isSessionReplaySampled];
+    // ERROR MODE
+   // BOOL isSampled = [self isSessionReplaySampled];
     BOOL isEnabled = [self isSessionReplayEnabled];
 
-    if ((isSampled && isEnabled) || (_sessionReplay.isManuallyActive && isEnabled) || self->_sessionReplay.isRunning) {
+    if ((isEnabled) || (_sessionReplay.isManuallyActive && isEnabled) || self->_sessionReplay.isRunning) {
+
+        // ERROR MODE
+   // if ((isSampled && isEnabled) || (_sessionReplay.isManuallyActive && isEnabled) || self->_sessionReplay.isRunning) {
         [_sessionReplay endSessionWithHarvest:isEnabled];
     }
 #endif
 }
 
 - (void) sessionReplayStart {
 #if !TARGET_OS_TV && !TARGET_OS_WATCH
+    // START ERROR MODE CHANGE
+
+    // should isSampled matter when deciding to start or not in every case?
+
     BOOL isSampled = [self isSessionReplaySampled];
-    if (isSampled && [self isSessionReplayEnabled]) {
-        [_sessionReplay startFromManual:FALSE];
-        @synchronized(kNRMAAnalyticsInitializationLock) {
-            [self.analyticsController setNRSessionAttribute:kNRMA_RA_hasReplay value:[[NRMABool alloc] initWithBOOL:YES]];
+    // always start session replay if its error or full
+    // ERROR MODE
+    if ([self isSessionReplayEnabled]) {
+        SessionReplayRecordingMode m = [self determineRecordingMode];
+
+        NRLOG_AGENT_DEBUG(@"Starting session replay with mode: %@", (m == SessionReplayRecordingModeFull) ? @"Full" : (m == SessionReplayRecordingModeError) ? @"Error" : @"Off");
+
+        if (m != SessionReplayRecordingModeOff) {
+
+            [_sessionReplay startFromManual:FALSE with:m];
+            @synchronized(kNRMAAnalyticsInitializationLock) {
+                [self.analyticsController setNRSessionAttribute:kNRMA_RA_hasReplay value:[[NRMABool alloc] initWithBOOL:YES]];
+            }
         }
     }
 #endif
@@ -685,11 +706,20 @@ - (BOOL) pauseReplay {
     return false;
 }
 
-static const NSString* kNRMA_BGFG_MUTEX = @"com.newrelic.bgfg.mutex";
-static const NSString* kNRMA_APPLICATION_WILL_TERMINATE = @"com.newrelic.appWillTerm";
+- (void)sessionReplayOnError:(NSError *_Nullable)error {
+#if !TARGET_OS_TV && !TARGET_OS_WATCH
+    if (_sessionReplay != nil) {
+        [_sessionReplay onError:error];
+    }
+#endif
+}
 
-- (void) applicationWillEnterForeground {
+static const NSString *kNRMA_BGFG_MUTEX = @"com.newrelic.bgfg.mutex";
+static const NSString *kNRMA_APPLICATION_WILL_TERMINATE =
+@"com.newrelic.appWillTerm";
 
+- (void)applicationWillEnterForeground {
+
     if (_isShutdown) {
         return;
     }
@@ -775,8 +805,11 @@ - (void) sessionStartInitialization {
 
 #if !TARGET_OS_TV && !TARGET_OS_WATCH
     if (@available(iOS 13.0, *)) {
-        BOOL isSampled = [self isSessionReplaySampled];
-        if (isSampled && [self isSessionReplayEnabled]) {
+       // ERROR MODE
+        // BOOL isSampled = [self isSessionReplaySampled];
+        if ([self isSessionReplayEnabled]) {
+
+        //if (isSampled && [self isSessionReplayEnabled]) {
             [self.analyticsController setNRSessionAttribute:kNRMA_RA_hasReplay value:[[NRMABool alloc] initWithBOOL:YES]];
         }
     }
@@ -1273,6 +1306,9 @@ - (BOOL)isClassNameUnmasked:(NSString *)className {
     return isUnmasked;
 }
 
+
+// SANPLING AND ERRORED SESSION SESSION REPLAY
+
 - (void) makeSampleSeeds {
     NRLOG_AGENT_DEBUG(@"config: RESEEDING");
 
@@ -1292,24 +1328,62 @@ - (BOOL) isSessionReplaySampled {
         sampleRate = [NRMAHarvestController configuration].session_replay_sampling_rate;
     }
     else {
-       // NRLOG_AGENT_DEBUG(@"isSessionReplaySampled using default rate of 100.0");
+        NRLOG_AGENT_DEBUG(@"isSessionReplaySampled using default rate of 100.0");
     }
-    //NRLOG_AGENT_DEBUG(@"isSessionReplaySampled session replay config: Sampling decision: %d, because seed <= rate: %f <= %f", (self.sessionReplaySampleSeed <= sampleRate), [[NewRelicAgentInternal sharedInstance] sessionReplaySampleSeed], sampleRate);
+    NRLOG_AGENT_DEBUG(@"isSessionReplaySampled session replay config: Sampling decision: %d, because seed <= rate: %f <= %f", (self.sessionReplaySampleSeed <= sampleRate), [[NewRelicAgentInternal sharedInstance] sessionReplaySampleSeed], sampleRate);
 
     return (self.sessionReplaySampleSeed <= sampleRate);
 }
 
+- (BOOL) isSessionReplayErrorSampled {
+    double errorSampleRate = 0.0;
+    if ( [NRMAHarvestController configuration] != nil) {
+        errorSampleRate = [NRMAHarvestController configuration].session_replay_error_sampling_rate;
+    }
+    else {
+        NRLOG_AGENT_DEBUG(@"isSessionReplaErrorSampled using default rate of 100.0");
+    }
+    NRLOG_AGENT_DEBUG(@"isSessionReplaErrorSampled session replay config: ERROR Sampling decision: %d, because seed <= rate: %f <= %f", (self.sessionReplayErrorSampleSeed <= errorSampleRate), [[NewRelicAgentInternal sharedInstance] sessionReplayErrorSampleSeed], errorSampleRate);
+
+    return (self.sessionReplayErrorSampleSeed <= errorSampleRate);
+}
+
 - (BOOL) isSessionReplayEnabled {
     BOOL isEnabled = false;
     if ( [NRMAHarvestController configuration] != nil) {
         isEnabled = [NRMAHarvestController configuration].session_replay_enabled;
     }
     else {
-        //NRLOG_AGENT_DEBUG(@"isSessionReplayEnabled using default value of false");
+        // NRLOG_AGENT_DEBUG(@"isSessionReplayEnabled using default value of false");
     }
-    //NRLOG_AGENT_DEBUG(@"isSessionReplayEnabled using value: %@", isEnabled ? @"true" : @"false");
+    // NRLOG_AGENT_DEBUG(@"isSessionReplayEnabled using value: %@", isEnabled ? @"true" : @"false");
 
     return isEnabled;
 }
 
+/**
+ * Determines the appropriate SessionReplay recording mode based on the sampling configuration.
+ *
+ * Logic:
+ * - If isSampled() is true: use FULL mode (continuous recording and sending)
+ * - Else if isErrorSampled() is true: use ERROR mode (buffering only, send on error)
+ * - Otherwise: use OFF mode (no recording)
+ *
+ * @param config The SessionReplayConfiguration with sampling rates
+ * @return The determined SessionReplayMode
+ */
+- (SessionReplayRecordingMode) determineRecordingMode {
+    if ([self isSessionReplaySampled]) {
+        return SessionReplayRecordingModeFull;
+    }
+    else if ([self isSessionReplayErrorSampled]) {
+        return SessionReplayRecordingModeError;
+    }
+    else {
+        return SessionReplayRecordingModeOff;
+    }
+}
+
+// END SAMPLING AND ERRORED SESSION SESSION REPLAY
+
 @end

Agent/HandledException/NRMAHandledExceptions.mm

@@ -24,6 +24,9 @@
 #import "Constants.h"
 #import "NRMAAttributeValidator.h"
 
+// Session Replay Error Sampling
+// END
+
 @interface NRMAAnalytics(Protected)
 // Because the NRMAAnalytics class interfaces with non Objective-C++ files, we cannot expose the API on the header. Therefore, we must use this reference. 
 - (std::shared_ptr<NewRelic::AnalyticsController>&) analyticsController;

Agent/Harvester/DataStore/NRMAAgentConfiguration.h

@@ -33,6 +33,7 @@
 @property(readonly,strong) NSString* loggingHost;
 @property(readonly,strong) NSString* loggingURL;
 @property(readonly,strong) NSString* sessionReplayURL;
+@property(readonly,strong) NSString* sessionReplayMode;
 
 @property(readonly,strong) NRMAAppToken* applicationToken;
 @property(atomic,strong) NSString* sessionIdentifier;

Agent/Harvester/DataStore/NRMAAgentConfiguration.m

@@ -121,7 +121,10 @@ - (id) initWithAppToken:(NRMAAppToken*)token
         [self setCollectorHost:collectorHost];
         [self setCrashCollectorHost:crashHost];
         [self setLoggingURL];
-
+
+        // Default mode
+        _sessionReplayMode = @"OFF";
+
         if ([[NSProcessInfo processInfo] environment][@"UITesting"]) {
             _useSSL = NO;
         } else {

Agent/Harvester/DataStore/NRMAHarvesterConfiguration.h

@@ -112,6 +112,7 @@
 @property(nonatomic,assign) BOOL      session_replay_enabled;
 @property(nonatomic,assign) double    session_replay_sampling_rate;
 @property(nonatomic,assign) double    session_replay_error_sampling_rate;
+// MASKING MODE
 @property(nonatomic,assign) NSString*    session_replay_mode;
 
 @property(nonatomic,assign) BOOL      session_replay_maskApplicationText;

Agent/Harvester/DataStore/NRMAHarvesterConfiguration.m

@@ -580,6 +580,9 @@ - (BOOL) isEqual:(id)object {
 
     // session replay equality
     if (self.session_replay_sampling_rate != that.session_replay_sampling_rate) return NO;
+
+    if (self.session_replay_error_sampling_rate != that.session_replay_error_sampling_rate) return NO;
+
     if (![self.session_replay_mode isEqualToString:that.session_replay_mode]) return NO;
     if (self.session_replay_enabled != that.session_replay_enabled) return NO;
     if (self.has_session_replay_config != that.has_session_replay_config) return NO;
@@ -622,10 +625,10 @@ - (NSUInteger) hash
 
 
     // session replay
-
-//    result = 31 * result + self.log_reporting_level.hash;
     result = 31 * result + self.session_replay_enabled;
     result = 31 * result + self.session_replay_sampling_rate;
+    result = 31 * result + self.session_replay_error_sampling_rate;
+
     result = 31 * result + self.session_replay_mode.hash;
 
     return result;

Agent/Network/NRMAHTTPUtilities.mm

@@ -187,7 +187,7 @@ + (NRMAPayloadContainer *) generatePayload {
     payload = NewRelic::Connectivity::Facade::getInstance().startTrip();
 
     if(payload == nullptr) {
-        NRLOG_DEBUG(@"Not attaching distributed tracing because account or application id are missing.");
+        NRLOG_AGENT_DEBUG(@"Not attaching distributed tracing because account or application id are missing.");
         return nil;
     }
     payload->setDistributedTracing(true);
@@ -196,7 +196,7 @@ + (NRMAPayloadContainer *) generatePayload {
 
 + (NRMAPayload *) startTrip {
     if(!NewRelic::Application::getInstance().isValid()) {
-        NRLOG_DEBUG(@"Not attaching distributed tracing because account or application id are missing.");
+        NRLOG_AGENT_DEBUG(@"Not attaching distributed tracing because account or application id are missing.");
         return nil;
     }