Capturing sessions

Bugsnag tracks the number of “sessions” that happen within your application. This allows you to compare stability scores between releases and helps you to understand the quality of your releases.

Sessions are captured and reported by default. This behavior can be disabled using the autoTrackSessions configuration option.

Automatic tracking

Bugsnag will automatically report a session each time the app is launched or enters the foreground having been in the background for 30 seconds or more.

Manual session handling

If you want control over what is deemed a session, you can switch off automatic session tracking with the autoTrackSessions option, and manage the session lifecycle using startSession, pauseSession and resumeSession on the Bugsnag client.

You should call these methods at the appropriate time in your application’s lifecycle when you wish to have an active session. Any errors which occur in your application outside of a session will still be reported to Bugsnag but will not count towards your application’s stability score.

startSession

Starts a new session to which subsequent handled and unhandled events will be attributed to.

[Bugsnag startSession];
Bugsnag.startSession()

If there is already an active session, it will be replaced with a new one. Use resumeSession if you only want to start a session when one doesn’t already exist.

pauseSession

Prevents further events being attributed to the current session until the session is resumed or a new session is started.

[Bugsnag pauseSession];
Bugsnag.pauseSession()

This can be advantageous if, for example, you do not wish the stability score to include crashes in a background service.

resumeSession

Resumes tracking events against the current session, if it was previously paused. If there is was no previous session, a new session is started. This method returns true if there was a session to resume or false if a new session was created.

if ([Bugsnag resumeSession]) // ...
if Bugsnag.resumeSession() // ...

Sessions are stored in memory for the lifetime of the application process and are not persisted on disk. Therefore calling this method on app startup would start a new session, rather than continuing any previous session.

Discarding and amending sessions

The data captured in a session can be customized using addOnSession as part of your Bugsnag configuration.

BugsnagConfiguration *config = [BugsnagConfiguration loadConfig];
[config addOnSessionBlock:^(BugsnagSession *session) {
    NSString *userId = [self getMyUserIdentifier]; // a custom user resolver
    [session setUser:userId withEmail:nil andName:nil];
    return YES; // Return false to discard
}];
[Bugsnag startWithConfiguration:config];
let config = BugsnagConfiguration.loadConfig()
config.addOnSession { (session) -> Bool in
    let userId = getMyUserIdentifier() // a custom user resolver
    session.setUser(userId, withEmail: nil, andName: nil)
    return true // Return false to discard
}
Bugsnag.start(with: config)

The return value from the callback block determines whether the session will be delivered to Bugsnag and so can be used to discard sessions if required.

Adding and removing callbacks

We recommend adding callbacks through the addOnSession configuration option to ensure that it is registered as soon as Bugsnag starts. However, the following methods are provided to allow callbacks to be added and removed whilst the application is running:

BugsnagOnSessionBlock cb = ^BOOL(BugsnagSession *session) { /* ... */ };
[Bugsnag addOnSessionBlock:cb];
// ...
[Bugsnag removeOnSessionBlock:cb];
func cb(session: BugsnagSession) -> Bool { /* ... */ }
Bugsnag.addOnSession(block: cb)
// ...
Bugsnag.removeOnSession(block: cb)

The BugsnagSession class

The following information is available on the BugsnagSession class, the representation of session information available in a session callback block.

property type description
app App A subset of the app data contained in error events.
device Device A subset of the device data contained in error events.
id String A unique ID for the session.
startedAt Date The timestamp that the session was started.
user/setUser User The active user for the session