Ahab's Studio.

一个轻量的 Android 端日志打印记录库

字数统计: 1.1k阅读时长: 4 min
2019/03/31 Share

地址:https://github.com/yhaolpz/PLog

PLog 即 Persistence Log,可持久化日志于文件,便于还原用户使用场景,解决异常问题。

特性:

1.mmap 方式高效写入,规避 IO 操作带来的性能消耗

2.兼容多进程并发文件写入,日志文件保存在各自的进程目录下

3.通过 zip 压缩并加密,节省上报流量,保护日志私密性

4.内置收集 Activity/Fragment 生命周期、崩溃、网络状态等常用信息:

使用

1.初始化
1
2
3
4
5
6
7
8
9
PLog.Config config = new PLog.Config.Builder(this)
.logDir(mLogDirPath) //日志存放目录,默认优先存储于SD卡
.logcatDebugLevel(PLog.DebugLevel.DEBUG) //允许输出到Logcat的级别
.recordDebugLevel(PLog.DebugLevel.DEBUG) //允许记录到日志文件的级别
.fileSizeLimitDay(15) //单天日志文件存储上限
.overdueDay(3) //日志文件过期天数
.cipherKey("123456") //日志密钥
.build();
PLog.init(config);
2.打印
1
2
3
4
5
6
7
8
9
//普通打印
PLog.d("wyh", "This is a log that can be recorded in a file");

//Format
PLog.d("wyh", "This is a %s", "log");

//数组类型
PLog.d("wyh", new String[]{"a", "b", "c"});
//output: [a,b,c]
3.只记录到日志文件
1
PLog.record(PLog.DebugLevel.DEBUG,"wyh","This is a log that can only be recorded in files");
4.只输出到logcat
1
PLog.print(PLog.DebugLevel.DEBUG,"wyh","This is a log");
5.触发上传
1
2
3
4
5
6
7
8
9
10
11
12
13
14
PLog.upload(new UploadListener() {
@Override
public void upload(@NonNull List<File> files) {
//上传到你的服务端
//...

//建议上传成功及时删除日志文件
for (File file : files) {
if (file.exists()) {
file.delete();
}
}
}
});

存储逻辑

日志文件类型

为更好的区分并管理日志,将从写入到上传经历不同状态的日志文件划分为以下类型:

  • “-mmap” 正在写入的日志文件,不可上传,文件命名为: yyyy-MM-dd-mmap
  • “-mmap-up” 写入完成的日志文件,可压缩上传,文件命名为: yyyy-MM-dd-mmap-up
  • “-mmap-up-old” 单天较早写入完成的日志大小,可压缩上传,文件命名为: yyyy-MM-dd-mmap-up-old
  • “-mmap-up-last” 触发上传时超出存储上限部分的日志文件,上传操作的中间态,不会长久存在,可压缩上传,文件命名为: yyyy-MM-dd-mmap-up-last
  • “.zip” 已压缩加密的日志文件,可直接上传,文件命名为: yyyy-MM-dd HH:mm:ss.zip

控制日志时效

暂定保留最近三天的日志,更早的日志将会在特定时机自动清除当前进程目录所有类型过期的日志文件,这些时机包括:

  • 初始化时
  • 触发上传重命名日志文件添加”-up”时
  • 触发上传压缩所有标记为”-up”的可上传的日志时
  • 触发上传扫描所有”.zip”可上传的日志时

控制存储上限

理论上我们应该避免无意义的日志记录滥用,控制日志体积,但为避免极端情况下大量日志写入导致存储爆炸,通过将日志文件分为两片控制存储上限。

譬如规定单天日志存储体积上限为 MAX,逻辑大致为下:

  • 当天日志文件 -mmap 写入体积达 MAX/3 时就会停止写入,并命名为 -mmap-up,然后新建文件 -mmap 继续写入
  • 当写入达 MAX/3 时,先将已存在的 -mmap-up 命名为 -mmap-up-old,再将刚写满的 -mmap 命名为 -mmap-up,然后新建文件 -mmap 继续写入
  • 当写入达 MAX/3 时,先删除 -mmap-up-old 文件,将已存在的 -mmap-up 命名为 -mmap-up-old,再将刚写满的 -mmap 命名为 -mmap-up,然后新建文件 -mmap 继续写入

按照此逻辑,假定当天写入日志体积为 SIZE,可以将单天日志存储情况划分为以下几种状态:

  • a. SIZE < MAX/3
  • b. MAX/3 < SIZE < MAX*2/3
  • c. MAX*2/3 < SIZE < MAX

当处于 a 状态时触发上传: -mmap –> -mmap-up –> zip
当处于 b 状态时触发上传: -mmap-up –> -mmap-up-old –> zip ; -mmap –> -mmap-up –> zip
当处于 c 状态时触发上传: -mmap-up-old –> zip ; -mmap-up –> zip ; -mmap –> -mmap-up-last –> zip

为了防止频繁的判断日志体积,可设置每隔一定写入条数后判断一次进行优化,目前设置间隔为 1000 条。

原文作者:Ahab

原文链接:http://yhaowa.gitee.io/f346f34f/

发表日期:March 31st 2019, 2:22:56 pm

更新日期:May 23rd 2020, 10:57:30 am

版权声明:本文采用知识共享署名-非商业性使用 4.0 国际许可协议进行许可

CATALOG
  1. 1. 特性:
  2. 2. 使用
    1. 2.0.0.1. 1.初始化
    2. 2.0.0.2. 2.打印
    3. 2.0.0.3. 3.只记录到日志文件
    4. 2.0.0.4. 4.只输出到logcat
    5. 2.0.0.5. 5.触发上传
  • 3. 存储逻辑
    1. 3.0.1. 日志文件类型
    2. 3.0.2. 控制日志时效
    3. 3.0.3. 控制存储上限