Repro Steps show you all of the interactions a user makes with your app up until a bug or crash is reported, grouped by the app view. For each view that a user visits, all of the steps that they commit are captured and displayed as logs next to the relevant screenshot. Repro steps can be found below the bug details.
For the following gestures, only the gesture is logged and displayed:
- Force touch
- Double tap
- Enabling/disabling a switch
- Changing the value of a slider
- Editing a text field.
Whenever one of the following lifecycle events occurs, it will be captured and shown on the timeline:
- Application is moved to the background
- Application is moved to the foreground
- Application becomes active
- Application becomes inactive
- Memory warning
Depending on the event, you'll find further details displayed as part of the log statement.
- Tap, double tap, and force touch: the SDK always tries to first capture the text rendered inside the UI that the user is interacting with, then we fall back to capturing the icon only with the buttons and navigation items, then, we fall back to the accessibility labels.
- Switch: Both the accessibility label as well as whether the user enabled or disabled the switch are logged.
- Slider: Both the accessibility label as well as the value that the user moves the slider to it are captured.
- Text fields: first, the SDK tries to capture the placeholder, then we fall back to the accessibility label.
Here are some examples of how the steps look like:
Tapped on the button "Send"
Double tapped on UI that contains "Instructions"
Started editing “Password“
Enabled the switch “Push Notifications“
Moved the slider “Text Size“ to 10%
App went to the background
App became active
A disclaimer will be shown at the bottom of the report. It helps your users view all the screenshots taken for the Repro Steps before sending a report and can delete them as well.
On your side, you can easily mark any view that might contain sensitive information, like payment details, as private. Any private view will automatically appear with a black overlay covering it in any screenshot. To make a view private, you can use the following property.
view.instabug_privateView = true
view.instabug_privateView = YES;
Minimum SDK Version
This feature requires a minimum iOS SDK version of 11.12.0.
Currently, Auto Masking is not yet supported on SwiftUI.
This feature automatically masks sensitive data when screenshots are captured, while protecting the user's privacy by default. This affects both Bug and Crash Reporting.
Instabug.setAutoMaskScreenshots([.textInputs]) //Default Value: .maskNothing
[Instabug setAutoMaskScreenshots: IBGAutoMaskScreenshotOptionTextInputs]; //Default Value: IBGAutoMaskScreenshotOptionMaskNothing
Here are all possible parameters.
//No Masking Applied .maskNothing //Masks Text Input .textInputs //Masks text labels, including buttons and titles .labels //Masks images and video .media
//No Masking Applied IBGAutoMaskScreenshotOptionMaskNothing //Masks Text Input IBGAutoMaskScreenshotOptionTextInputs //Masks text labels, including buttons and titles IBGAutoMaskScreenshotOptionLabels //Masks images and video IBGAutoMaskScreenshotOptionMedia
|Mask Text Inputs only.|
|Mask Text Inputs and Labels.|
|Disable auto masking.|
The Private Views API takes precedence over Auto Masking.
Repro Steps is by default enabled with screenshots for bug reporting, and enabled without screenshots for crash reporting.
Instabug.setReproStepsFor(.all, with: .enable)
[Instabug setReproStepsFor:IBGIssueTypeAll withMode:IBGUserStepsModeEnable];
You can change the value of the Issue Type.
//Bug Reporting and Crash Reporting .all //Bug Reporting Only .bug //Crash Reporting Only .crash //Session Replay Only .sessionReplay
//Bug Reporting and Crash Reporting IBGIssueTypeAll //Bug Reporting Only IBGIssueTypeBug //Crash Reporting Only IBGIssueTypeCrash //Session Replay Only IBGIssueTypeSessionReplay
You can change the value of the User Steps Mode.
//Enable with Screenshots .enable //Enable with NO Screenshots .enabledWithNoScreenshots //Disable .disable
//Enable with Screenshots IBGUserStepsModeEnable //Enable with NO Screenshots IBGUserStepsModeEnabledWithNoScreenshots //Disable IBGUserStepsModeDisable
| Swift: |
|Enable with Screenshots for both Bug Reporting and Crash Reporting.|
|Enable with No Screenshots for Crash Reporting.|
|Enable with Screenshots for Bug Reporting.|
|Completely disable for both Bug Reporting and Crash Reporting.|
To be able to capture Repro Steps, we need to do method swizzling. We take an approach to swizzling that is absolutely safe and does not impact your app negatively in any way. For more details, you can check here. This swizzling can be disabled if you would prefer to log the user interactions manually.
Screenshots are by default disabled for Crash Reporting.
For Crash Reporting, screenshots are by default disabled; however, if you are looking to enable screenshots in Crash Reporting, make sure to use the Auto Masking API. This API will automatically help you mask sensitive data in screenshots to protect the end-users' privacy.
Updated 13 days ago