From 7af9c7861f6375043fea7c039c194b9b4205e7cc Mon Sep 17 00:00:00 2001 From: Andreas Linde Date: Mon, 6 Aug 2012 17:14:05 +0200 Subject: [PATCH] Improve crash reporting troubleshooting documentation --- ...g-Crash-Reporting-Not-Working-template.md} | 30 +++++++++++++------ docs/index.md | 2 +- 2 files changed, 22 insertions(+), 10 deletions(-) rename docs/{Troubleshooting-Crashes-Dont-Appear-template.md => Troubleshooting-Troubleshooting-Crash-Reporting-Not-Working-template.md} (58%) diff --git a/docs/Troubleshooting-Crashes-Dont-Appear-template.md b/docs/Troubleshooting-Troubleshooting-Crash-Reporting-Not-Working-template.md similarity index 58% rename from docs/Troubleshooting-Crashes-Dont-Appear-template.md rename to docs/Troubleshooting-Troubleshooting-Crash-Reporting-Not-Working-template.md index 04ac29fcb2..c1d4060c78 100644 --- a/docs/Troubleshooting-Crashes-Dont-Appear-template.md +++ b/docs/Troubleshooting-Troubleshooting-Crash-Reporting-Not-Working-template.md @@ -1,14 +1,26 @@ -## Crashes Don't Appear +## Crash Reporting is not working -This is a checklist to help find the issue if crashes do not appear in HockeyApp: +This is a checklist to help find the issue if crashes do not appear in HockeyApp or the dialog asking if crashes should be send doesn't appear: 1. Check if the `BETA_IDENTIFIER` or `LIVE_IDENTIFIER` matches the App ID in HockeyApp. -2. Check if CFBundleIdentifier in your Info.plist matches the Bundle Identifier of the app in HockeyApp. HockeyApp accepts crashes only if both the App ID and the Bundle Identifier equal their corresponding values in your plist and source code. -3. Unless you have set `[BITCrashManager setCrashManagerStatus:]` to `BITCrashManagerStatusAutoSubmit`: If your app crashes and you start it again, is the alert shown which asks the user to send the crash report? If not, please crash your app again, then connect the debugger and set a break point in `BITCrashManager.m`, method `startManager` to see why the alert is not shown. -4. Check if the code is really executed by adding an `NSLog` statement. -5. If you are using `#ifdef (CONFIGURATION_something)`, make sure that the `something` string matches the exact name of your Xcode build configuration. Spaces are not allowed! -6. Remove of at least disable any other exception handler or crash reporting framework. -7. If there an older version of PLCrashReporters framework `CrashReporter.framework` added to the project, remove it. -6. If it still does not work, please [contact us](http://support.hockeyapp.net/discussion/new). + +2. Check if CFBundleIdentifier in your Info.plist matches the Bundle Identifier of the app in HockeyApp. HockeyApp accepts crashes only if both the App ID and the Bundle Identifier equal their corresponding values in your plist and source code. + +3. Unless you have set `[BITCrashManager setCrashManagerStatus:]` to `BITCrashManagerStatusAutoSubmit`: If your app crashes and you start it again, is the alert shown which asks the user to send the crash report? If not, please crash your app again, then connect the debugger and set a break point in `BITCrashManager.m`, method `startManager` to see why the alert is not shown. + +4. Enable the debug logging option and check the output if the Crash Manager gets `Setup`, `Started`, returns no error message and sending the crash report to the server results in no error: + + [[BITHockeyManager shareHockeyManager] setDebugLogEnabled: YES]; + + +5. Make sure Xcode debugger is not attached while causing the app to crash + +6. If you are using `#ifdef (CONFIGURATION_something)`, make sure that the `something` string matches the exact name of your Xcode build configuration. Spaces are not allowed! + +7. Remove of at least disable any other exception handler or crash reporting framework. + +8. If there an older version of PLCrashReporters framework `CrashReporter.framework` added to the project, remove it. + +9. If it still does not work, please [contact us](http://support.hockeyapp.net/discussion/new). diff --git a/docs/index.md b/docs/index.md index 1b067f6945..596b06f746 100644 --- a/docs/index.md +++ b/docs/index.md @@ -32,4 +32,4 @@ The main SDK class is `BITHockeyManager`. It initializes all modules and provide ## Troubleshooting - [Symbolication doesn't work](Symbolication-Doesnt-Work) (Or the rules of binary UUIDs and dSYMs) -- [Crashes do not appear on HockeyApp](Troubleshooting-Crashes-Dont-Appear) +- [Crash Reporting is not working](Troubleshooting-Crash-Reporting-Not-Working)