饿了么Trojan日志SDK介绍

trojan_banner.png

Trojan是一个稳定高效的移动端轻量级日志SDK,稳定运行于饿了么物流多个产品线上,已无bug。既可以记录通用日志,比如网络请求、电量变化、页面生命周期,也可以记录自定义的日志,从而可以通过用户日志来帮助我们定位分析问题。具有以下特点:

  • 简洁的 API,通过几行代码就可以接入,实现日记记录功能;
  • 使用 AOP 技术 Lancet 框架插桩收集通用日志,并且支持增量编译;
  • 使用 mmap 技术,保证日记记录的高效性;
  • 扩展性高,开发者可以自定义日志文件的上传功能;
  • 流量开销小,支持在线配置,远程控制用户日志文件上传与否;
  • 稳定性高,目前已稳定运行在饿了么物流团队众包等多个 APP 上。

综述

在开源的 Trojan SDK中,目前采集了 Activity 和 Fragment 生命周期,View Click 事件,网络状态变化,手机电量状态变化等基础日志,还通过 AOP 技术插桩 KLog采集 Log 日志,要是项目中未使用 KLog,也可以根据项目情况具体定制。考虑到每个项目中网络模块的实现框架都不尽相同,有 OkHttpVolleyAndroid-Async-Http 等等,所以采集网络日志这一部分不方便统一处理,需要使用者通过 Lancet 插桩具体网络框架来收集日志。在 Demo 中具体以 OkHttp 为例,实现采集 Http request 和 response 的功能,可作为参考。而与业务相关的日志,需要使用者自己采集。

配置

在根目录的 build.gradle 添加:

buildscript {
    dependencies {
        .......
        classpath 'me.ele:lancet-plugin:1.0.2'
    }
}

在 app 目录的 'build.gradle' 添加:

apply plugin: 'me.ele.lancet'

dependencies {
    ......
    provided 'me.ele:lancet-base:1.0.2'
    compile 'me.ele:trojan-library:0.0.4'
}

使用

1. 初始化

在自定义的 Application 添加:

TrojanConfig config = new TrojanConfig.Builder(this)
    // Set user information
    .userInfo("xxxx")
    // Set device id
    .deviceId("xxxx")
    // Set cipher key if need encry log
    .cipherKey("xxxx")
    // Optional, save log file in sdcard by default
    .logDir("xxxx")
    // Console log switch, the default is open
    .enableLog(true)
    .build();
Trojan.init(config);

特别说明:

  1. 日志文件默认保存在 sdcard 中,即使应用被卸载,也不会丢失日志;
  2. 为兼容多进程,避免文件相互干扰,日志文件保存在各自的目录下,目录以进程名来命名;
  3. 默认情况下日志不加密,考虑到加密的高效性,目前仅提供TEA加密方式,解密工具仍在探索中,敬请期待。

2. 记录日志

Trojan 提供两种方式记录日志:

第一种:

Trojan.log("Trojan", "We have a nice day!");

第二种:

List<String> msgList = new LinkedList<>();
msgList.add("Hello Trojan!");
msgList.add("We have a nice day!");
msgList.add("Hello world!");
Trojan.log("Trojan", msgList);

默认情况下,对于单行日志不加密,如果需要加密,则使用如下:

Trojan.log("Trojan", "We have a nice day!", true);

3. 用户信息

当用户信息发生改变或者切换用户时,可以调用:

Trojan.refreshUser("new user info");

当然了,要是用户登出,可以传空值,即表示登出操作:

Trojan.refreshUser(null);

4. 上传方案

针对日志上传,在 Demo 中提供了 LeanCloud 这种免费简单的方式,可以实现上传、浏览、下载等文件服务的基本功能,可供参考。

备注

通过集成 Trojan,可以轻松实现用户日志的记录功能,是不是很简单呀!要是对 Lancet 的使用有疑问,大家可以参考 https://github.com/eleme/lancet/blob/dev/README_zh.md,这里就不赘述。

最后

非常欢迎大家使用并且star,要是有任何疑问,可以留言或者提issues!非常感谢您的关注!

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,497评论 25 707
  • 国家电网公司企业标准(Q/GDW)- 面向对象的用电信息数据交换协议 - 报批稿:20170802 前言: 排版 ...
    庭说阅读 10,868评论 6 13
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,599评论 18 139
  • 面对生活和自己,笑靥如花,心中充满一个“Z”
    薇薇董阅读 163评论 0 0
  • 最近和朋友们沟通到事业规划比较多,也时而聊起我这些年的创业经历。10+年来我主要还是混迹于地产圈,并不是一个真正意...
    悦己者容Grace阅读 503评论 1 1