KSCrash翻译

KSCrash:一个终极的iOS crash reporter

为何使用KSCrash?

因为在现有的一些crash reporter报告崩溃时,KSCrash还能比它们还能做得更多。以下是KSCrash的一些关键属性:

1. 支持离线重新符号化的设备上符号化(在iOS版本中,许多功能已经被修改)。
2. 生成完全的苹果报告,每个字段都不落下
3. 支持32或64位 
4. 能处理只能在mach级别捕获的错误,比如堆栈溢出。
5. 跟踪由于未捕获的c++异常导致的REAL。
6. 在crash自己的回调里处理crash(或者在用户的crash回调里)
7. 检测僵尸(释放)对象访问尝试
8. 在僵尸或内存损坏的情况下恢复丢失的NSException消息
9. 在寄存器和堆栈上自省对象(C字符串和Objective-C对象,包括ivars)。
10. 提取关于异常引用的对象的信息(例如"unrecognized selector sent to instance 0xa26d9a0")
11. 它的可插入服务报告体系结构使其易于适应任何API服务。
12. 转储堆栈内容。
13. 诊断crash原因(Crash医生)
14. 以JSON格式记录苹果崩溃报告所不能记录的大量信息。
15. 支持包括程序员提供的额外数据(崩溃前和崩溃期间)

KSCrash支持处理以下类型的crash:

mach 内核异常
致命信号(Fatal signals)
C++ 异常
OC异常
主线程死锁
自定义crash(比如来自脚本语言的自定义crash)

KSCrash可以向以下服务器报导:

Hockey
QuincyKit
Victory
Email

新特性:

C++异常处理:
是的,通常你的app由于未捕获的C++异常而终止,你会看到这样的堆栈:

Thread 0 name:  Dispatch queue: com.apple.main-thread
Thread 0 Crashed:
0   libsystem_kernel.dylib          0x9750ea6a 0x974fa000 + 84586 (__pthread_kill + 10)
1   libsystem_sim_c.dylib           0x04d56578 0x4d0f000 + 292216 (abort + 137)
2   libc++abi.dylib                 0x04ed6f78 0x4ed4000 + 12152 (abort_message + 102)
3   libc++abi.dylib                 0x04ed4a20 0x4ed4000 + 2592 (_ZL17default_terminatev + 29)
4   libobjc.A.dylib                 0x013110d0 0x130b000 + 24784 (_ZL15_objc_terminatev + 109)
5   libc++abi.dylib                 0x04ed4a60 0x4ed4000 + 2656 (_ZL19safe_handler_callerPFvvE + 8)
6   libc++abi.dylib                 0x04ed4ac8 0x4ed4000 + 2760 (_ZSt9terminatev + 18)
7   libc++abi.dylib                 0x04ed5c48 0x4ed4000 + 7240 (__cxa_rethrow + 77)
8   libobjc.A.dylib                 0x01310fb8 0x130b000 + 24504 (objc_exception_rethrow + 42)
9   CoreFoundation                  0x01f2af98 0x1ef9000 + 204696 (CFRunLoopRunSpecific + 360)
...

根本没法跟踪这个异常是啥和在哪抛出的!
现在有了KSCrash,你可以从下面信息获得未捕获的异常类型、描述、和它抛出的地方:

Application Specific Information:
*** Terminating app due to uncaught exception 'MyException', reason: 'Something bad happened...'

Thread 0 name:  Dispatch queue: com.apple.main-thread
Thread 0 Crashed:
0   Crash-Tester                    0x0000ad80 0x1000 + 40320 (-[Crasher throwUncaughtCPPException] + 0)
1   Crash-Tester                    0x0000842e 0x1000 + 29742 (__32-[AppDelegate(UI) crashCommands]_block_invoke343 + 78)
2   Crash-Tester                    0x00009523 0x1000 + 34083 (-[CommandEntry executeWithViewController:] + 67)
3   Crash-Tester                    0x00009c0a 0x1000 + 35850 (-[CommandTVC tableView:didSelectRowAtIndexPath:] + 154)
4   UIKit                           0x0016f285 0xb4000 + 766597 (-[UITableView _selectRowAtIndexPath:animated:scrollPosition:notifyDelegate:] + 1194)
5   UIKit                           0x0016f4ed 0xb4000 + 767213 (-[UITableView _userSelectRowAtPendingSelectionIndexPath:] + 201)
6   Foundation                      0x00b795b3 0xb6e000 + 46515 (__NSFireDelayedPerform + 380)
7   CoreFoundation                  0x01f45376 0x1efa000 + 308086 (__CFRUNLOOP_IS_CALLING_OUT_TO_A_TIMER_CALLBACK_FUNCTION__ + 22)
8   CoreFoundation                  0x01f44e06 0x1efa000 + 306694 (__CFRunLoopDoTimer + 534)
9   CoreFoundation                  0x01f2ca82 0x1efa000 + 207490 (__CFRunLoopRun + 1810)
10  CoreFoundation                  0x01f2bf44 0x1efa000 + 204612 (CFRunLoopRunSpecific + 276)
...

方便的C++开发助手

如果你打开跟踪打印:
[KSCrash sharedInstance].printTraceToStdout = YES;
它会在你的app抛出未捕获C++异常的时候打印一个合适的堆栈跟踪信息到标准输出(stdout)上!否则调试器只会将你引向重新抛出异常的位置。

自定义Crash和堆栈跟踪

你现在可以报导你自己自定义的crash和堆栈跟踪信息(想一下脚本语言)

- (void) reportUserException:(NSString*) name
                  reason:(NSString*) reason
              lineOfCode:(NSString*) lineOfCode
              stackTrace:(NSArray*) stackTrace
        terminateProgram:(BOOL) terminateProgram;

详情见KSCrash.h文件。

不稳定的特性

下列特性被认为是"不稳定"的,并且默认禁用:
死锁检测

不兼容API更改通知

从2013年1月29日起,我修改了KSCrash主API,使用属性而不是初始化方法参数进行配置。有了所有的新选择后,事情开始变得有点棘手。这应该是最后一个主要的API更改。

注意:初始化KSCrash的首选方法现在是通过安装对象,而不是直接使用过滤器。详见“如何使用KSCrash”。

如何build KSCrash

1 选中KSCrash的scheme
2 选择iOS设备
3 Products菜单里选择Archive

当build完成,会在Finder看到framework,你可以像使用任何其他framework一样使用它。

如何使用KSCrash

1 添加这个framework到你的工程(或者添加KSCrash工程进来,作为依赖项)
2 添加下列系统framework和lib到你的工程

libc++.dylib
libz.dylib
MessageUI.framework (iOS only)
SystemConfiguration.framework

3 在Build Setting是的Other Linker Flags里添加"-Objc"标识
4 添加下列内容到你app delegate的 [application: didFinishLaunchingWithOptions:]方法里:

#import <KSCrash/KSCrash.h>
// Include to use the standard reporter.
#import <KSCrash/KSCrashInstallationStandard.h>
// Include to use Quincy or Hockey.
#import <KSCrash/KSCrashInstallationQuincyHockey.h>
// Include to use the email reporter.
#import <KSCrash/KSCrashInstallationEmail.h>
// Include to use Victory.
#import <KSCrash/KSCrashInstallationVictory.h>

- (BOOL)application:(UIApplication*) application didFinishLaunchingWithOptions:(NSDictionary*) launchOptions
{
KSCrashInstallationStandard* installation = [KSCrashInstallationStandard sharedInstance];
installation.url = [NSURL URLWithString:@"http://put.your.url.here"];

// OR:

KSCrashInstallationQuincy* installation = [KSCrashInstallationQuincy sharedInstance];
installation.url = [NSURL URLWithString:@"http://put.your.url.here"];

// OR:

KSCrashInstallationHockey* installation = [KSCrashInstallationHockey sharedInstance];
installation.appIdentifier = @"PUT_YOUR_HOCKEY_APP_ID_HERE";

// OR:

KSCrashInstallationEmail* installation = [KSCrashInstallationEmail sharedInstance];
installation.recipients = @[@"some@email.address"];

// Optional (Email): Send Apple-style reports instead of JSON
[installation setReportStyle:KSCrashEmailReportStyleApple useDefaultFilenameFormat:YES]; 

// Optional: Add an alert confirmation (recommended for email installation)
[installation addConditionalAlertWithTitle:@"Crash Detected"
                                 message:@"The app crashed last time it was launched. Send a crash report?"
                               yesAnswer:@"Sure!"
                                noAnswer:@"No thanks"];

// OR:

KSCrashInstallationVictory* installation = [KSCrashInstallationVictory sharedInstance];
installation.url = [NSURL URLWithString:@"https://put.your.url.here/api/v1/crash/<application key>"];

[installation install];
    …
}

这将安装崩溃哨兵系统(可以拦截crashes并将报告存存盘)。不过注意,你还可以为各种安装设置其他你想要的其他属性。
一旦你准备发送任何的crash报告,调用如下方法:

[installation sendAllReportsWithCompletion:^(NSArray *filteredReports, BOOL completed, NSError *error)
{
 // Stuff to do when report sending is complete
}];

推荐阅读

如果可以的话,你应该阅读下列头文件来完全理解KSCrash所拥有的特性和如何使用它:

KSCrash.h
KSCrashInstallation.h
KSCrashInstallation(SPECIFIC TYPE).h
Architecture.md

高端用法

允许设备内置符号化

允许高级功能

KSCrash具有一些在一片茫然中检查崩溃报告时非常有用的高级功能。其中一些涉及到较小的权衡,因此大多数默认情况下是禁用的。

自定义用户数据(KSCrash.h中的userInfo)

设置userInfo属性后,你可以将自定义用户数据存储到下一次的crash report上

僵尸对象跟踪(KSCrash.h中的zombieCacheSize)

KSCrash具有检测僵尸对象(指向已释放对象的悬停指针)的能力。它通过记录已释放对象的类型和地址来做到这一点。它将这些值存储在缓存中,并切断已释放对象的地址。这意味着,设置缓存的大小越小,哈希冲突发生的几率越大。并且你将因此失去先前已释放对象的信息。

启用僵尸跟踪后,KSCrash还将检测丢失的NSException并打印其内容。某些类型的内存损坏或堆栈损坏崩溃可能会导致异常提前释放,从而进一步影响调试应用程序的工作,因此该特性有时非常方便。

权衡:僵尸跟踪的代价是向对象释放位置添加非常小的开销,并保留一些内存。

死锁检测(KSCrash.h中的deadlockWatchdogInterval)

严正警告!!本功能是不稳定的!它会呈现假阳性并使你的app崩溃!

内存自省(KSCrash.h中的introspectMemory)

当应用程序崩溃时,内存中通常残留有被栈、寄存器甚至异常消息引用的对象和字符串。当启用此功能时,KSCrash将内省这些内存区域并将它们的内容存储到crash report中。

你也可以通过设置doNotIntrospectClasses属性,指定一个类的列表,来避免这些类的自省。

自定义crash处理代码(KSCrash.h中的onCrash)

如果你想在crash发生时做一些额外操作(比如添加更多的上下文数据信息到报告中去),你可以这么做。

然而,你必须确保你只使用异步安全的代码。并且最重要的是,不要那个方法里调用OC代码!在很多情况下,你都可以这样做,但是在某些特定的崩溃类中,无视此警告的处理程序代码将导致崩溃处理程序崩溃! 注意,如果发生这种情况,KSCrash将检测它并编写完整的报告,尽管您的自定义处理程序代码可能没有完全运行!

权衡: 你必须小心你所放入的自定义崩溃处理代码!

KSCrash 日志重定向

这会将KSCrash将要打印到控制台的内容,写到一个文件里。我通常用这个功能来调试KSCrash自身,但它也可以拍派很多其他用场,所以我公开为它公开了一个API!

例子

workspace中包含了几个例子app,用来演示常见的KSCrash用法。请看下每个AppDelegate.m文件的顶部信息来了解它做了什么。

原链接: https://github.com/kstenerud/KSCrash

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容

  • Swift1> Swift和OC的区别1.1> Swift没有地址/指针的概念1.2> 泛型1.3> 类型严谨 对...
    cosWriter阅读 11,065评论 1 32
  • 第一次加入芽儿少儿美术教师群 ,有种说不出来的感觉。我喜欢这种正能量的传播。更加让我坚信毕业以后的道路。...
    小雨点点阅读 528评论 0 0
  • 下午值班时和同事聊起孩子的学习,我说希望孩子学习更好点,能够进入年级前十名将来考个重本。 她说,你当初怎么没考...
    白丁2009阅读 552评论 1 0
  • 思成风 墨染苍穹,唯吾独凄零,言不尽相思惆忧迫于心,落的珠泪潺声声。 思成风,如影随行,忘吾含泪细细声,昨日...
    空城锦阅读 268评论 0 0
  • *西懊「查理九世西奥黑化+年上」埃克斯。 「西懊,你要去那了是吗」埃克斯撑着下巴的坐在位子上看着一本心理书,而此时...
    安湮酒阅读 5,627评论 2 6