×

iOS用CocoaLumberJack抓取crash日志上传

96
小风过街
2016.05.17 09:57* 字数 1596

会的不难,难的不会,这大概就是温习旧知识和学习新知识时的感受了吧。

这几天百度Debug日志管理,利用CocoaLumberJack第三方库搭建自己的Log系统,本文记录一下学习使用CocoaLumberJack的过程。

最开始时设想的需求是:

可以积攒到一定量的Log,或者定期,一次性把存储的Log发送给服务器,不能打一个Log就发一次。

需要解决的问题有:

1.应该在什么地方打印Log才能记录下有用的信息,如果每个函数都打印,不仅繁琐而且杂乱的信息量过大;
2.Log日志里面需要记录下哪些信息;
3.清理过期无用的日志。
4.在debug版中需要把日志打印到Xcode控制台便于查看,而在release版中不能在控制台中打印Log。

所幸找到了iOS上非常优秀的第三方日志管理库--CocoaLumberJack
完全满足最开始设想的需求。

关于刚刚的问题:

1,在觉得有可能发生crash的地方,例如空值、数组越界、不存在方法的引用......只能说实践得真知,边做边看吧。
2,打印 函数名、方法名、行号。
3,CocoaLumberJack自动帮我们实现了日志的记录和删除。
4,使用宏定义Debug开关。iOS: 如何在工程中设置 DEBUG 模式

关于CoCoaLumberJack的使用方法,还是先看github上的UsageGettingStarted吧。
它可结合XcodeColor插件,让Xcode控制台打印的日志带上颜色。

CoCoaLumberJack的日志级别有如下几种:
  • LOG_LEVEL_ERROR:如果设置为LOG_LEVEL_ERROR,仅仅能看到Error相关的日志输出。
  • LOG_LEVEL_WARN:如果设置为LOG_LEVEL_WARN,能看到Error、Warn相关的日志输出。
  • LOG_LEVEL_INFO:如果设置为LOG_LEVEL_INFO,能够看到Error、Warn、Info相关的日志输出。
  • LOG_LEVEL_DEBUG:如果设置为LOG_LEVEL_DEBUG,能够看到Error/Warn/Info/Debug相关的日志输出。
  • LOG_LEVEL_VERBOSE:如果设置为LOG_FLAG_VERBOSE,能够看到所有级别的日志输出。
  • LOG_LEVEL_OFF:不输出日志。

DDLogLevel 定义了全局的 log 等级,DDLogFlag 是我们打 log 时设定的 log 等级,CocoaLumberjack 会比较两者,如果 flag 低于 level,则不会打 log:

那么开始我的实现过程

一.

使用宏来处理,指定日志的记录级别
创建一个PCH文件,并添加如下代码:
'
#ifndef PrefixHeader_pch
#define PrefixHeader_pch

//定义并导入CoCoaLumberJack框架
#define LOG_LEVEL_DEF ddLogLevel
#import <CocoaLumberjack.h>

//通过DEBUG模式设置全局日志等级,DEBUG时为Verbose,所有日志信息都可以打印,否则Error,只打印
#ifdef DEBUG
static const DDLogLevel ddLogLevel = DDLogLevelVerbose;
#else
static const DDLogLevel ddLogLevel = DDLogLevelError;
#endif

#endif /* PrefixHeader_pch */

在代码中就可以使用DDLogError/DDLogWarn/DDLogDebug/DDLogVerbose来无缝替代NSLog,例如:

DDLogError(@"[Error]:%@", @"输出错误信息");//输出错误信息
DDLogWarn(@"[Warn]:%@", @"输出警告信息");//输出警告信息
DDLogInfo(@"[Info]:%@", @"输出描述信息");//输出描述信息
DDLogDebug(@"[Debug]:%@", @"输出调试信息");//输出调试信息
DDLogVerbose(@"[Verbose]:%@", @"输出详细信息");//输出详细信息

但是这样并不能满足我们打印文件名、函数名、行号的需求,
于是,在PCH文件中,再次宏定义一下,例如DDLogError:

#ifdef DEBUG
#define DLog(format, ...) DDLogError((@"[文件名:%s]" "[函数名:%s]" "[行号:%d]" format), __FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__);
#else
#define DLog(...);
#endif

这样我们可以用DLog替代DDLogError打印,并且每次都会自动打印出文件名、函数名、行号信息。

DLog(@"User selected file:%@ withSize:%d", @"filePath", 123);

控制台输出:

�[fg214,57,30;2016-05-17 01:17:22:443 MD5[28301:3795644] [文件名:/Users/lg/Desktop/Log/Log/ViewController.m][函数名:-[ViewController viewDidLoad]][行号:31]User selected file:filePath withSize:123

二.

把CocoaLumberjack框架添加到你的项目

需要添加的主要文件有四个:
1.@DDLog(整个框架的基础)
2.@DDASLLogger(发送日志语句到苹果的日志系统,以便它们显示在Console.app上)
3.@DDTTYLoyger(发送日志语句到Xcode控制台,如果可用)
4.@DDFIleLoger(把日志语句发送至文件)

DDLog是强制性的,其余的都是可选的,这取决于你打算如何使用这个框架。例如,如果你不打算纪录到一个文件,你可以跳过DDFileLogger,或者你想跳过ASL以便更快的文件记录,你可以跳过DDASLLoger。

需要注意的是:

在使用DDLogError或者DLog之前,首先得在application:didFinishLaunchingWithOptions:方法中配置这个日志框架:

//开始时,你需要下面两行代码:
[DDLog addLogger:[DDASLLogger sharedInstance]]; 
[DDLog addLogger:[DDTTYLogger sharedInstance]]; 
//这将在你的日志框架中添加两个“logger”。也就是说你的日志语句将被发送到Console.app和Xcode控制 台(就像标准的NSLog)

//这个框架的好处之一就是它的灵活性,如果你还想要你的日志语句写入到一个文件中,你可以添加和配置一个file logger:
fileLogger = [[DDFileLogger alloc] init]; 
fileLogger.rollingFrequency = 60 * 60 * 24; // 24 hour rolling 
fileLogger.logFileManager.maximumNumberOfLogFiles = 7; 

[DDLog addLogger:fileLogger]; 

//上面的代码告诉应用程序要在系统上保持一周的日志文件。
//如果不设置rollingFrequency和maximumNumberOfLogFiles,
//则默认每天1个Log文件、存5天、单个文件最大1M、总计最大20M,否则自动清理最前面的记录。

接下来上传,可以从DDLogFileManager protocol下面的两个协议中获取Log文件rolling时的通知,便可以在此时将Log文件上传:

//Notifications from DDFileLogger
- (void)didArchiveLogFile:(NSString *)logFilePath;
- (void)didRollAndArchiveLogFile:(NSString *)logFilePath;
但是我并没有这样做,因为后来发现一个问题:

即使记录了很多Log文件,依然不知道在程序有没有崩溃过。如果根据最开始的设想,上传了那么多Log文件,根本不可能一个个的去看它们的Log文件是否有崩溃信息。而CocoaLumberJack只会记录下我们主动打印过的信息,而不会抓取、记录下苹果自带的crash信息,更不会在下一次程序启动时通知我们程序是否崩溃过。

三.

所以,我们需要抓取苹果自带的crash信息,借鉴网上的方法,ios Crash闪退日志获取和上传至服务器

新建一个CatchCrash类:
CatchCrash.h
#import <Foundation/Foundation.h>

@interface CatchCrash : NSObject
void uncaughtExceptionHandler(NSException *exception);
@end

CatchCrash.m
#import "CatchCrash.h"
#import "PrefixHeader.pch"

@implementation CatchCrash

//在AppDelegate中注册后,程序崩溃时会执行的方法
void uncaughtExceptionHandler(NSException *exception)
{
    //获取系统当前时间,(注:用[NSDate date]直接获取的是格林尼治时间,有时差)
    NSDateFormatter *formatter =[[NSDateFormatter alloc] init];
    [formatter setDateFormat:@"yyyy-MM-dd HH:mm:ss"];
    NSString *crashTime = [formatter stringFromDate:[NSDate date]];
    //异常的堆栈信息
    NSArray *stackArray = [exception callStackSymbols];
    //出现异常的原因
    NSString *reason = [exception reason];
    //异常名称
    NSString *name = [exception name];

    //拼接错误信息
    NSString *exceptionInfo = [NSString stringWithFormat:@"crashTime: %@ Exception reason: %@\nException name: %@\nException stack:%@", crashTime, name, reason, stackArray];

    //把错误信息保存到本地文件,设置errorLogPath路径下
    //并且经试验,此方法写入本地文件有效。
    NSString *errorLogPath = [NSString stringWithFormat:@"%@/Documents/error.log", NSHomeDirectory()];
    NSError *error = nil;
    BOOL isSuccess = [exceptionInfo writeToFile:errorLogPath atomically:YES encoding:NSUTF8StringEncoding error:nil];
    if (!isSuccess) {
        DLog(@"将crash信息保存到本地失败: %@", error.userInfo);
}

完成了CatchCrash类,接下来,AppDelegate.h里 #import "CatchCrash.h"
在didFinishLaunchingWithOptions中添加如下代码:

//注册消息处理函数的处理方法
//如此一来,程序崩溃时会自动进入CatchCrash.m的uncaughtExceptionHandler()方法
NSSetUncaughtExceptionHandler(&uncaughtExceptionHandler);

四.

最后一步:

在didFinishLaunchingWithOptions中,判断crash文件的写入路径errorLogPath下是否存在crash文件,若存在,说明上一次app有crash,则将该crash信息写入CocoaLumberJack的Log文件夹下,然后删掉errorLogPath下的crash文件,再上传Log到服务器

//若crash文件存在,则写入log并上传,然后删掉crash文件
NSFileManager *fileManager = [NSFileManager defaultManager];
NSString *errorLogPath = [NSString stringWithFormat:@"%@/Documents/error.log", NSHomeDirectory()];

if ([fileManager fileExistsAtPath:errorLogPath]) {
    //用CocoaLumberJack库的fileLogger.logFileManager自带的方法创建一个新的Log文件,这样才能获取到对应文件夹下排序的Log文件
    [fileLogger.logFileManager createNewLogFile];
    //此处必须用firstObject而不能用lastObject,因为是按照日期逆序排列的,即最新的Log文件排在前面
    NSString *newLogFilePath = [fileLogger.logFileManager sortedLogFilePaths].firstObject;
    NSError *error = nil;
    NSString *errorLogContent = [NSString stringWithContentsOfFile:errorLogPath encoding:NSUTF8StringEncoding error:nil];
    BOOL isSuccess = [errorLogContent writeToFile:newLogFilePath atomically:YES encoding:NSUTF8StringEncoding error:&error];
    
    if (!isSuccess) {
        DLog(@"crash文件写入log失败: %@", error.userInfo);
    } else {
        DLog(@"crash文件写入log成功");
        NSError *error = nil;
        BOOL isSuccess = [fileManager removeItemAtPath:errorLogPath error:&error];
        if (!isSuccess) {
            DLog(@"删除本地的crash文件失败: %@", error.userInfo);
        }
    }

    //上传最近的3个log文件,
    //至少要3个,因为最后一个是crash的记录信息,另外2个是防止其中后一个文件只写了几行代码而不够分析
    NSArray *logFilePaths = [fileLogger.logFileManager sortedLogFilePaths];
    NSUInteger logCounts = logFilePaths.count;
    if (logCounts >= 3) {
        for (NSUInteger i = 0; i < 3; i++) {
            NSString *logFilePath = logFilePaths[i];
            //上传服务器
            ...
        }
    } else {
        for (NSUInteger i = 0; i < logCounts; i++) {
            NSString *logFilePath = logFilePaths[i];
            //上传服务器
            ...
        }
    }
}
Tip:

可以通过控制打印文件路径,复制,在finder中通过command+shift+g键快速搜索,粘贴路径,来查看检测Log文件是否写入成功。

至此,我的Log日志上传服务器就基本完成了。
水平有限,不当之处欢迎指导指正。

另外:

我试了下,若在CatchCrash.m的uncaughtExceptionHandler()方法中直接将错误信息打印到CocoaLumberJack的Log文件夹下却无法实现,程序每次一执行到createNewLogFile方法时就跳出了uncaughtExceptionHandler()函数,以至于没执行后面的writeToFile(),具体原因还不知。。。
错误方法的代码如下:

//获取到AppDelegate中注册的fileLogger
DDFileLogger *fileLogger = DDLog.allLoggers.firstObject;
//程序崩溃时,把系统捕获到的错误信息写入本地文件
[fileLogger.logFileManager createNewLogFile];
NSString *newLogFilePath = [fileLogger.logFileManager sortedLogFilePaths].firstObject;
[exceptionInfo writeToFile:newLogFilePath atomically:YES encoding:NSUTF8StringEncoding error:nil];
参考文章:

CocoaLumberJack
iOS开发中善用日志记录工具
iOS: #ifdef DEBUG
ios Crash闪退日志获取和上传至服务器
日志记录最佳实践
IOS写日志文件并保存到Documents

iOS_issues
Web note ad 1