Sentry

Sentry and Bird Eats Bug combine for faster, better testing and debugging.

What does this integration offer?

The integration connects errors in Sentry to a Bird Eats Bug recording, allowing a much easier way to understand the user's experience when going over error data in Sentry. There's a clear correlation between error data in Sentry and issues reported from users with Bird Eats Bug.

Prerequisites

Make sure you have Sentry installed in your application and either Bird Eats Bug SDK installed in your application or the browser extension installed in your browser.

Sentry Configuration

The following Sentry configuration change adds the URL returned by window.birdeatsbug?.session?.link || window.birdeatsbugExtension?.session?.link to the payload of Sentry events.

const sentryConfig = {
	// ...otherConfig
	beforeSend: function (event) {
		// Add the Bird Eats Bug session link to the payload, if it exists.
		const birdeatsbugSessionURL = window.birdeatsbug?.session?.link || window.birdeatsbugExtension?.session?.link
		if (birdeatsbugSessionURL) {
			if (!event.contexts) event.contexts = {}
			event.contexts['Bird Eats Bug'] = {
				url: birdeatsbugSessionURL,
			}
		}
		return event
	},
}

The links to Bird Eats Bug recordings will now appear in the event details. Clicking them will open a new browser tab, allowing you to quickly view the user reported recording and associated data in Bird Eats Bug.

Limitations

Bird Eats Bug does not auto-upload recordings. The user has to take a submit action to upload the recording. This means that in the moment in time when an error occurs and is sent to Sentry, it is only known whether there's an ongoing recording with Bird Eats Bug, and under which URL the recording will be accessible if the user uploads it. However, the user might choose not to upload the Bird Eats Bug recording. In this case, Sentry will link to a Bird Eats Bug recording that is not accessible. Bird Eats Bug replay sessions reported with the browser extension will never be linked on Sentry.