LogReport 当 App 崩溃的时，把崩溃信息保存到本地的同时，自动给 GitHub @codeKK AndroidOpen Source Website

LogReport

Introduction: 当 App 崩溃的时，把崩溃信息保存到本地的同时，自动给 GitHub 提交崩溃 issue。另外，崩溃信息支持邮件上传和 HTTP 上传，自动提交到 issue 使用的是邮件上传的方式。如果你拥有私人服务器，你也可以使用 HTTP 上传。

More: Author ReportBugs

Tags:

日志上传-

当 App 崩溃的时，把崩溃信息保存到本地的同时，自动给 GitHub 提交崩溃 issue，你只需要几句，就能完成所有配置，更多细节请了解下方

另外，崩溃信息支持邮件上传和 HTTP 上传，自动提交到 issue 使用的是邮件上传的方式。如果你拥有私人服务器，你也可以使用 HTTP 上传

enter image description here

特性介绍

特性	简介
自定义日志保存路径	默认保存在 Android/data/com.xxxx.xxxx/log 中
自定义日志缓存大小	默认大小为 30M，超出后会自动清空文件夹
支持多种上传方式	目前支持邮件上传与 HTTP 上传，会一并把文件夹下的所有日志打成压缩包作为附件上传
日志加密保存	提供 AES，DES 两种加密解密方式支持，默认不加密
日志按天保存	目前崩溃日志和 Log 信息是按天保存，你可以继承接口来实现更多的保存样式
携带设备与 OS 信息	在创建日志的时候，会一并记录 OS 版本号，App 版本，手机型号等信息，方便还原崩溃
自定义日志上传的时机	默认只在 Wifi 状态下上传支持，也支持在 Wifi 和移动网络下上传
支持保存 Log 日志	在打印 Log 的同时，把 Log 写入到本地（保存的时候会附带线程名称，线程 id，打印时间），还原用户操作路径，为修复崩溃提供更多细节信息
GitHub 自动提交 issue	使用邮件发送的形式，把接受崩溃日志的邮箱和 GitHub 特定的开源项目绑定在一起即可，更多细节请看下面介绍

依赖添加

在你的项目根目录下的 build.gradle 文件中加入依赖

allprojects {
    repositories {
        ...
        maven { url "https://jitpack.io" }
    }
}

添加依赖

dependencies {
    compile 'com.github.wenmingvs:LogReport:1.0.3'
}

初始化

在自定义 Application 文件加入以下几行代码即可，默认使用 email 发送。如果您只需要在本地存储崩溃信息，不需要发送出去，请把 initEmailReport（）删掉即可。

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        initCrashReport();
    }

    private void initCrashReport() {
        LogReport.getInstance()
                .setCacheSize(30 * 1024 * 1024)//支持设置缓存大小，超出后清空
                .setLogDir(getApplicationContext(), "sdcard/" + this.getString(this.getApplicationInfo().labelRes) + "/")//定义路径为：sdcard/[app name]/
                .setWifiOnly(true)//设置只在 Wifi 状态下上传，设置为 false 为 Wifi 和移动网络都上传
                .setLogSaver(new CrashWriter(getApplicationContext()))//支持自定义保存崩溃信息的样式
                //.setEncryption(new AESEncode()) //支持日志到 AES 加密或者 DES 加密，默认不开启
                .init(getApplicationContext());
        initEmailReporter();
    }

    /**
     * 使用 EMAIL 发送日志
     */
    private void initEmailReporter() {
        EmailReporter email = new EmailReporter(this);
        email.setReceiver("wenmingvs@gmail.com");//收件人
        email.setSender("wenmingvs@163.com");//发送人邮箱
        email.setSendPassword("apptest1234");//邮箱的客户端授权码，注意不是邮箱密码
        email.setSMTPHost("smtp.163.com");//SMTP 地址
        email.setPort("465");//SMTP 端口
        LogReport.getInstance().setUploadType(email);
    }
}

上传

在任意地方，调用以下方法即可，崩溃发生后，会在下一次 App 启动的时候使用 Service 异步打包日志，然后上传日志，发送成功与否，Service 都会自动退出释放内存

LogReport.getInstance().upload(context);

发往服务器

如果您有自己的服务器，想往服务器发送本地保存的日志文件，而不是通过邮箱发送。请使用以下方法替换 initEmailReporter 方法


    /**
     * 使用 HTTP 发送日志
     */
    private void initHttpReporter() {
        HttpReporter http = new HttpReporter(this);
        http.setUrl("http://crashreport.jd-app.com/your_receiver");//发送请求的地址
        http.setFileParam("fileName");//文件的参数名
        http.setToParam("to");//收件人参数名
        http.setTo("你的接收邮箱");//收件人
        http.setTitleParam("subject");//标题
        http.setBodyParam("message");//内容
        LogReport.getInstance().setUploadType(http);
    }

保存 Log 到本地

使用以下方法，打印 Log 的同时，把 Log 信息保存到本地（保存的时候会附带线程名称，线程 id，打印时间），并且随同崩溃日志一起，发送到特定的邮箱或者服务器上。帮助开发者还原用户的操作路径，更好的分析崩溃产生的原因

LogWriter.writeLog("wenming", "打 Log 测试！！！！");

关于使用邮件上传的注意事项

强烈建议使用 163 邮箱作为发送崩溃的邮箱，并且此邮箱务必要开启 SMTP 服务，如下图所示，才能发送邮件成功！
邮箱的密码，请输入 163 邮箱的客户端授权码，而不要输入邮箱的登录密码
请不要使用 QQ 邮箱作为发件人的邮箱，因为 QQ 邮箱的多重验证原因，并不支持这种形式的邮件发送
如果你需要自动提交崩溃日志到 GitHub 中，您需要使用 Gmail 邮箱作为收件人邮箱
提供以下测试邮箱给大家体验，此邮箱可以发送邮箱
测试帐号
帐号：wenmingvs@163.com
登录密码：apptest123
客户端授权码：apptest1234

GitHub 自动提交 issue 的配置

请保证崩溃日志的邮件能到达您设定的 Gmail 邮箱中。如下图所示，才继续下去 enter image description here

通过发送邮件来创建 issue，在没有 GitHub API 的支持下，是不可能实现的。但是我们可以通过一些已经得到 GitHub 授权的第三方应用来实现。通过设置邮件监听，一旦邮箱收到了包含特定关键字的邮件，就会读取邮件的内容和标题，自动帮你提交 issue。我们需要做的，就是把邮箱和 GitHub 的开源项目绑定起来，设置触发器即可，每次新邮件到达的时候，会检查此邮件是否满足触发器要求，如果满足，就会帮你自动提交 issue。

快速教程

首先去注册一个帐号，如下图所示链接
绑定 Gmail 邮箱，设置监听的邮件的类型，我们选择 unread，即监听所有未读邮件（后面可以再根据个人要求修改）
绑定 GitHub
设置创建 issue 的样式，在 3 个输入框中指定以下内容指定在哪个项目下创建 issue issue 的标题与邮件的标题相同 issue 的内容和邮件的内容相同
设定成功！！
进入个人面板管理链接，面板管理的 Home 标题下的每一个框框，都代表一个触发器，其中每个触发器都绑定了一个 GitHub 的开源项目

后面我们还需要调整一下触发器，点击触发器的 Edit，进入下面界面，做如下设置

设定监听的邮件类型为 New Email Matching Search
设定按照邮件的标题，对邮件做进一步筛选。设定的 subject:LogReport，意思是对标题包含有 LogReport 关键字的邮件做捕获。通过设定不同的关键字，我们就可以给不同的 GitHub 上的开源项目提交 issue 了
对触发的动作做指示。我们需要自动提交 issue，所以应该按照以下来设定，不再赘述了，看图：
最后，我们返回到个人面板，如果触发器如下图所示是 On 状态，说明已经启动了！至此，自动提交崩溃 issue 的配置就完成了

最后附上我的测试帐号，大家可以根据我的触发器的配置作为参考~
帐号：wenmingvs@163.com
密码：apptest1234

Gradle 构建

版本
- 最新 Android SDK
- 最新 Gradle
环境变量
- ANDROID_HOME
- GRADLE_HOME，同时把 bin 放入 path 变量
- Android SDK 安装，都更新到最新
- Android SDK Build-tools 更新到最新
- Google Repository 更新到最新
- Android Support Repository 更新到最新
- Android Support Library 更新到最新