{"id":885,"date":"2026-09-29T14:19:28","date_gmt":"2026-09-29T08:49:28","guid":{"rendered":"https:\/\/www.shakebug.com\/blog\/?p=885"},"modified":"2026-09-29T14:19:28","modified_gmt":"2026-09-29T08:49:28","slug":"in-app-bug-reporting-sdk","status":"publish","type":"post","link":"https:\/\/www.shakebug.com\/blog\/in-app-bug-reporting-sdk\/","title":{"rendered":"In-App Bug Reporting SDK: The Complete Guide for Mobile Teams"},"content":{"rendered":"

An in-app bug reporting SDK is a library you add to your mobile app so testers and users can file a bug from inside the app. The report arrives with an annotated screenshot, a screen recording, network and console logs, and device details already attached. Shakebug does this with one SDK family for iOS, Android, Flutter, React Native and web, and it has a free plan with no credit card required.<\/p>\n

This guide covers what these SDKs actually capture, how each platform is set up, what happens to a report after it’s filed, and what to check before you pick one. If you already know your platform, jump straight to its setup guide: iOS<\/a>, Android<\/a>, Flutter<\/a>, or React Native<\/a>.<\/p>\n

<\/span>Why crash reporting alone misses most bugs<\/span><\/h2>\n

Crash reporters only see crashes. A checkout total that’s off by one cent, a button that does nothing on one Android skin, or a screen that renders blank after a slow API call never throws an exception. So they never show up in Crashlytics or any other crash-only tool.<\/p>\n

Those bugs reach you as a Slack message: “checkout is broken.” Then comes the usual back-and-forth. Which device? Which build? What did you tap before that? Were you logged in? By the time you have answers, the tester has moved on and the state that caused the bug is gone.<\/p>\n

An in-app bug reporting SDK fixes that by recording the context at the moment someone notices the problem. The tester doesn’t need to know what a stack trace is. They shake the phone, circle the wrong number, type one line, and send.<\/p>\n

<\/span>What an in-app bug reporting SDK captures<\/span><\/h2>\n

Here’s what a Shakebug report contains, compared with what a crash-only tool gives you for the same issue:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Data<\/th>\nCrash-only reporter<\/th>\nShakebug in-app report<\/th>\n<\/tr>\n<\/thead>\n
Stack trace for crashes<\/td>\nYes<\/td>\nYes, captured automatically<\/td>\n<\/tr>\n
Non-crash bugs (wrong UI, logic errors)<\/td>\nNo<\/td>\nYes, filed by shake, screenshot, or a button<\/td>\n<\/tr>\n
Annotated screenshot<\/td>\nNo<\/td>\nYes<\/td>\n<\/tr>\n
Screen recording<\/td>\nNo<\/td>\nYes<\/td>\n<\/tr>\n
Network requests<\/td>\nNo<\/td>\nYes<\/td>\n<\/tr>\n
Console logs<\/td>\nPartial (breadcrumbs, depending on the tool)<\/td>\nYes<\/td>\n<\/tr>\n
Device model, OS version, app version<\/td>\nYes<\/td>\nYes<\/td>\n<\/tr>\n
What the user did before the bug<\/td>\nBreadcrumbs, if you instrument them<\/td>\nSession Journey timeline<\/td>\n<\/tr>\n
Who the user is<\/td>\nIf you set a user ID<\/td>\nUser Journey, once you set custom user details<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Network logs are usually the part that closes the ticket. Most “the screen is empty” bugs turn out to be a 401 or a malformed payload. For a walkthrough of reading them in a real report, see how to capture network logs in React Native<\/a>.<\/p>\n

<\/span>Four ways a report gets filed<\/span><\/h2>\n

Shake-to-report gets the attention, but it’s one of four triggers. You’ll likely want more than one.<\/p>\n

Shake the device.<\/strong> On by default on every mobile SDK. You can turn it off if shaking conflicts with a feature in your app (a dice game, a fitness tracker).<\/p>\n

Take a screenshot.<\/strong> The OS screenshot gesture opens the reporter. This is off by default in the React Native, Flutter and web SDKs and on by default in the iOS SDK, according to the property tables on the installation docs.<\/p>\n

Call it from your own UI.<\/strong> Put a “Report a problem” item in your settings menu and call triggerBugReporting()<\/code>. This matters for production users, who won’t know about the shake gesture.<\/p>\n

Crash.<\/strong> Unhandled crashes are captured and sent without anyone doing anything. On iOS you can also attach a recording of the last 18 to 20 seconds before the crash with allowAutoCaptureScreenForCrashes(true)<\/code>. The docs note that this can cost a little UI performance, so test it on your lowest-end supported device before you ship it.<\/p>\n

Here’s the manual trigger on native iOS and Android:<\/p>\n

\/\/ iOS (Swift)\r\nShakeBugSDK.sharedInstance.triggerBugReporting()\r\n\r\n\/\/ Android (Kotlin)\r\nShakeBug.sharedInstance().triggerBugReporting()<\/code><\/pre>\n
<\/span>Setup by platform<\/span><\/h2>\n
Every platform follows the same three steps. Create a project in the Shakebug dashboard, copy the app key, and initialize the SDK once at app start. The snippets below show only the initialization. Each platform guide covers permissions, optional settings and testing in full.<\/p>\n
<\/span>iOS (Swift, Objective-C, SwiftUI)<\/span><\/h3>\n
Swift Package Manager is the recommended install. Add the package https:\/\/github.com\/softnoesis\/ShakeBug\/<\/code> in Xcode and pick the latest version. CocoaPods still works but is deprecated. The minimum deployment target is iOS 13.0.<\/p>\n
import ShakeBug\r\n\r\nfunc application(_ application: UIApplication,\r\n                 didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {\r\n    ShakeBugSDK.sharedInstance.initiateWithKey(\"YOUR_IOS_APP_KEY\")\r\n    return true\r\n}<\/code><\/pre>\n
You also need NSPhotoLibraryUsageDescription<\/code> in Info.plist<\/code>. Full walkthrough: iOS bug reporting with Shakebug<\/a>.<\/p>\n
<\/span>Android (Kotlin, Java)<\/span><\/h3>\n
Add the Gradle dependency, and add maven { url 'https:\/\/jitpack.io' }<\/code> under your repositories:<\/p>\n
\/\/ app\/build.gradle\r\nimplementation 'com.softnoesis.shakebug:ShakeBug:1.2.51'<\/code><\/pre>\n
Then initialize in your Application<\/code> class or launch activity:<\/p>\n
override fun onCreate(savedInstanceState: Bundle?) {\r\n    super.onCreate(savedInstanceState)\r\n    ShakeBug.sharedInstance().initiateWithKey(this, \"YOUR_ANDROID_APP_KEY\")\r\n}<\/code><\/pre>\n
Check the installation docs<\/a> for the current SDK version before you copy the version number. Full walkthrough: Android bug reporting with Shakebug<\/a>.<\/p>\n
<\/span>Flutter<\/span><\/h3>\n
Shakebug ships as an official Flutter plugin, so there’s no native host code to write. Run flutter pub add shakebug<\/code>, then wrap your root widget:<\/p>\n
import 'package:shakebug\/shakebug.dart';\r\n\r\nvoid main() {\r\n  runApp(\r\n    ShakebugSDK(\r\n      androidAppKey: 'YOUR_ANDROID_APP_KEY',\r\n      iosAppKey: 'YOUR_IOS_APP_KEY',\r\n      child: MaterialApp(home: const HomeScreen()),\r\n    ),\r\n  );\r\n}<\/code><\/pre>\n
Crash capture is on by default through allowCrashReport<\/code>, and it covers both Dart exceptions and native crashes. Full walkthrough, including the Android and iOS permissions: Flutter crash reporting SDK setup guide<\/a>.<\/p>\n
<\/span>React Native<\/span><\/h3>\n
Install the package with npm install shakebug-react-native<\/code> and run cd ios && pod install<\/code>. Android needs minSdkVersion<\/code> 24 or later. Then wrap your app in ShakebugView<\/code>:<\/p>\n
import ShakebugView from 'shakebug-react-native';\r\n\r\nexport default function App() {\r\n  return (\r\n    <ShakebugView\r\n      Android_appkey=\"YOUR_ANDROID_APP_KEY\"\r\n      iOS_appkey=\"YOUR_IOS_APP_KEY\"\r\n    >\r\n      <NavigationContainer independent>\r\n        {\/* your app *\/}\r\n      <\/NavigationContainer>\r\n    <\/ShakebugView>\r\n  );\r\n}<\/code><\/pre>\n
If NavigationContainer<\/code> sits inside ShakebugView<\/code>, pass it the independent<\/code> prop as shown above. Full walkthrough: React Native crash reporting guide<\/a>. Already on Crashlytics? The Crashlytics to Shakebug migration guide<\/a> shows how to run both side by side before you switch.<\/p>\n
<\/span>Web (React, Next.js and other JS apps)<\/span><\/h3>\n
The web SDK is the @softnoesis\/shakebug-js<\/code> npm package. It’s a React component, so react<\/code> and react-dom<\/code> are peer dependencies:<\/p>\n
import '@softnoesis\/shakebug-js\/dist\/index.css';\r\nimport { Shakebug } from '@softnoesis\/shakebug-js';\r\n\r\nfunction App() {\r\n  return (\r\n    <>\r\n      <Shakebug appKey=\"YOUR_APP_KEY\" bundleId=\"https:\/\/your-site.com\" showFloatingButton={true} \/>\r\n      {\/* your app *\/}\r\n    <\/>\r\n  );\r\n}<\/code><\/pre>\n
Users can also open the reporter with Cmd + Alt + K<\/code> on macOS or Ctrl + Alt + K<\/code> on Windows and Linux. If you only need testers to report bugs on a site you don’t control the code for, the Shakebug Chrome extension<\/a> does it with no install in the app.<\/p>\n
<\/span>Useful calls after the SDK is in<\/span><\/h2>\n
Three calls make reports much easier to act on. The method names are the same on every platform, and the argument styles differ slightly.<\/p>\n
Identify the user.<\/strong> Once you set custom user details, every bug, crash and session from that person links together in their User Journey.<\/p>\n
\/\/ React Native\r\naddCustomUser(\"user_123\", \"John Doe\", \"john@example.com\", \"US\", \"beta tester\");\r\n\r\n\/\/ Android (Kotlin)\r\nShakeBug.sharedInstance().addCustomUser(\"user_123\", \"john@example.com\", \"John Doe\", \"US\", \"beta tester\")<\/code><\/pre>\n
Log custom events.<\/strong> addEventKey<\/code> attaches an event (for example “checkout_started”) to the timeline, so a report shows the business step the user was on, not just the screen.<\/p>\n
Hide sensitive screens.<\/strong> In React Native, wrap anything private in ShakebugSdkProtectedView<\/code> so it isn’t captured in screenshots or recordings.<\/p>\n
<\/span>From report to fix: Session Journey and Crash AI<\/span><\/h2>\n
Getting the report filed is half the job. The other half is making it quick to act on.<\/p>\n
Session Journey<\/strong> shows the timeline that led to the bug: sessions, screens, events, earlier bugs and crashes, in order. It works for anonymous users too, grouped by device, so apps without a login still get the full story. Here’s how that looks on a real report: session replay for mobile apps with Session Journey<\/a>.<\/p>\n
Crash AI<\/strong> handles the other side. One bug in a release can produce hundreds of crash reports, and obfuscation or inlining can make identical crashes look different. Crash AI groups duplicates into one issue with a first-seen date, the affected devices and OS versions, and a trend. That means your team triages one issue instead of 200 alerts. Why exact stack-trace matching fails and what pattern-based grouping does instead: why obfuscated builds break crash grouping<\/a>. Product overview: AI crash grouping<\/a>.<\/p>\n
From there, reports go to the tools your team already uses. Shakebug integrates with Jira, Linear, GitHub, GitLab, Slack, Trello, Asana, ClickUp, Monday.com, Wrike and email.<\/p>\n
<\/span>What to check before you pick an in-app bug reporting SDK<\/span><\/h2>\n
Run through this list against any SDK you’re evaluating, including Shakebug:<\/p>\n
Does it cover every platform you ship?<\/strong> If you have a Flutter app and a React web dashboard, one vendor for both means one place to triage. Check that each platform has a real SDK, not just a webview wrapper.<\/p>\n
What’s attached without extra code?<\/strong> Network logs and console logs should come for free. If you have to write an interceptor to get network data, most testers’ reports will arrive without it.<\/p>\n
How are crashes grouped?<\/strong> Ask how the tool handles obfuscated or minified builds. Exact stack-trace matching creates duplicate issues after every release.<\/p>\n
Can you control what’s captured?<\/strong> Look for a way to exclude sensitive screens, and for a self-hosted or on-premise option if your data can’t leave your infrastructure. Shakebug has a self-hosted plan<\/a>, and the SDK supports a custom endpoint.<\/p>\n
How is it priced?<\/strong> Per-event pricing punishes you in exactly the release where crashes spike. Check what the free tier includes and what the paid tier costs as your monthly active users grow. Shakebug’s plans are on the pricing page<\/a>.<\/p>\n
And where Shakebug is not the right tool: it isn’t a backend APM or server-side tracing product. If your main problem is slow database queries or distributed tracing across microservices, you need an observability tool, and Shakebug can sit next to it for the mobile side. The installation docs also list no SDK for Unity or Kotlin Multiplatform, so check for yourself if you need one of those. For side-by-side comparisons, see the best mobile crash reporting tools in 2026<\/a>.<\/p>\n
<\/span>Frequently asked questions<\/span><\/h2>\n
What is an in-app bug reporting SDK?<\/strong>
\nIt’s a library you add to a mobile or web app so users and testers can report a bug from inside the app. The SDK attaches a screenshot, screen recording, network and console logs, and device details to the report automatically, so developers don’t have to ask for them.<\/p>\n
Is there a free bug reporting SDK for iOS and Android?<\/strong>
\nYes. Shakebug has a free Basic plan with no credit card required. It covers iOS and Android, plus Flutter, React Native and web. Current limits for each plan are listed on the Shakebug pricing page.<\/p>\n
What’s the difference between a bug reporting SDK and a crash reporting SDK?<\/strong>
\nA crash reporting SDK only captures crashes and unhandled exceptions, automatically. A bug reporting SDK also lets people report problems that don’t crash the app, like wrong data, broken layouts or buttons that do nothing, with visual and log context. Shakebug does both in one SDK.<\/p>\n
Do I need a separate SDK for each platform?<\/strong>
\nYou install the package that matches your stack: the native SDK for iOS or Android, the shakebug<\/code> plugin for Flutter, shakebug-react-native<\/code> for React Native, or @softnoesis\/shakebug-js<\/code> for web. All of them report into the same Shakebug dashboard, so a team shipping several platforms triages everything in one place.<\/p>\n
Can users report bugs without shaking the phone?<\/strong>
\nYes. You can trigger the reporter from a screenshot or from your own button with triggerBugReporting()<\/code>. On web there’s a floating button and a keyboard shortcut. Shake-to-report can be turned off entirely.<\/p>\n
<\/span>Get started<\/span><\/h2>\n
Pick your platform guide above, or create a free Shakebug account<\/a> and copy your app key from the dashboard. Setup is one package and one initialization call. Shake your test device once, and the first report shows up in your dashboard with the screenshot, logs and device details attached.<\/p>\n

\n