Skip to main content

Configuration

Launching with options

warning

iOS/iPadOS: Make sure you launch your app with Bugsee on a real device. Underlying Bugsee iOS SDK does not work in simulator as it heavily depends on the hardware.

Bugsee behavior is very customizable, if default configuration is not satisfying your needs you can launch the SDK with additional parameters. Use instance of IOSLaunchOptions or AndroidLaunchOptions for corresponding platform to change Bugsee behavior.

using BugseePlugin;
using System.Collections.Generic;

namespace YourNameSpace
{
[Register("AppDelegate")]
public partial class AppDelegate : UIApplicationDelegate
{
public override bool FinishedLaunching(UIApplication application, NSDictionary launchOptions)
{
var bugseeOptions = new IOSLaunchOptions();

bugseeOptions.ShakeToReport = true;
bugseeOptions.ReportPrioritySelector = true;
bugseeOptions.DefaultBugPriority = BugseeSeverityLevel.Critical;

Bugsee.Launch("<your_app_token>", bugseeOptions);
return base.FinishedLaunching(application, launchOptions);
}
}
}

Available Options

For iOS

KeyDefaultNotes
CaptureLogstrueAutomatically capture all console logs
CrashReporttrueCatch and report application crashes (*)
DefaultBugPriorityHighDefault priority for bugs
DefaultCrashPriorityBlockerDefault priority for crashes
KillDetectionfalseDetect abnormal termination (experimental, read more)
MaxRecordingTime60Maximum recording duration
MonitorNetworktrueCapture network traffic
ReportPrioritySelectorfalseAllow user to modify priority when reporting manual
ScreenshotToReporttrueScreenshot key to trigger report
ShakeToReportfalseShake gesture to trigger report
StyleDefaultEnumeration of Default, Dark and BasedOnStatusBar
VideoEnabledtrueEnable video recording
FrameRateHighSpecifies how often frames are captured
ScreenshotEnabledtrueAttach screenshot to a report
WifiOnlyUploadfalseUpload reports only when a device is connected to a WiFi network
MaxDataSize50Bugsee will avoid using more disk space than specified (in MB). If total Bugsee data size exceeds specified value, oldest recordings (even not sent) will be removed. Value should not be smaller than 10
CaptureDeviceAndNetworkNamestrueCapture device name, wifi SSID and mobile carrier name.
warning
  • iOS allows only one crash detector to be active at a time, if you insist on using an alternative solution for handling crashes, you might want to use this option and disable Bugsee from taking over.

For Android

KeyDefaultNotes
CaptureLogstrueAutomatically capture all console logs
CrashReporttrueCatch and report application crashes
DefaultBugPriorityHighDefault priority for bugs
DefaultCrashPriorityBlockerDefault priority for crashes
ExtendedVideoModefalseEnables or disables the use of MediaProjection API (**)
FrameRateHighSpecifies how often frames are captured
LogLevelVerboseMinimal log level of Logcat messages, which will be attached to report
MaxDataSize50Maximum disk space consumed by Bugsee
MaxRecordingTime60Maximum recording duration
MonitorNetworktrueCapture network traffic
NotificationBarTriggertrueTrigger report from notification bar
ReportPrioritySelectorfalseAllow user to modify priority when reporting manual
ScreenshotEnabledtrueAttach screenshot to a report
ServiceModefalseUsed, when Bugsee is launched from service. No video and no visual controls available. Recording continues even in background.
ShakeToTriggerfalseShake gesture to trigger report
VideoEnabledtrueEnable video recording
WifiOnlyUploadfalseUpload reports only when a device is connected to a WiFi network
CaptureDeviceAndNetworkNamestrueCapture device name, wifi SSID and mobile carrier name.
warning

** If ExtendedVideoMode is set to true, MediaProjection API is used, while recording video. In this case all types of views are recorded, but user is asked to allow video recording. If false (experimental), view drawing cache is used to capture the screen. In this case user is not asked to allow video recording, but frame rate is lower and some special views like status bar, soft keyboard and views, which contain Surface (MapView, VideoView, GlSurfaceView, etc.) are not recorded. Option has no effect, if VideoEnabled option is set to false.

Stop, Relaunch

It is also possible to relaunch Bugsee with other options later

// Relaunch with other options.
var options = new IOSLaunchOptions();

// Set other launch options
//...

Bugsee.Relaunch(options);

or stop the events and video recording.

// Stop recording completely
Bugsee.Stop()

Handling UnobservedTaskExceptions

Starting with version 4.5 of .NET Framework, exceptions thrown within the Tasks are not causing app to crash any more. Instead, they are rerouted to UnobservedTaskExceptions event handlers. By default, we do not capture them to reduce noise. If, however, you need them to be captured, enable that feature by setting the following option (same for all the platforms):

BugseePlugin.Bugsee.HandleTaskExceptions = true;

NOTE: Starting from Bugsee.Xamarin 1.4.6 this option is enabled by default.