通过命令行启用 logcat 日志本地存储功能

注意：本文基于 Android 12 进行分析
Qidi 2023.12.06 (MarkDown & Haroopad)

0. 背景

在 Android 系统上进行开发时，为了分析 bug，有些时候我们需要抓取开机日志。

很多人知道，通过界面操作进入 开发者选项 就可以打开 logcat 日志的本地存储功能，从而很方便的抓取完整的开机日志。但是，当 Java 层有某些关键服务没能正常启动时，图形界面也很可能一直处于黑屏状态，导致无法通过屏幕操作进入到 开发者选项 来启用日志存储。

有人说那我们还可以提前执行 adb logcat 命令，再对设备上电，一样可以抓到完整开机日志。没错，大多数设备上是可以这样操作。但是，对于某些设备来说， 要么仅有一个 USB 接口，还被某个外设占用了，无法同时用于外设连接和 ADB 连接；要么虽然有多个 USB 接口，但必须等系统启动后手动将 USB 切换到 devices 模式后，才能进行 ADB 连接。这种情况下，就算提前执行 adb logcat 命令，但因为找不到设备，所以也无法抓取到开机日志。

因此我们需要一种方式，在不进行界面操作或切换 USB Role 的情况下，也能启用 logcat 日志的本地存储。

1. 通过命令行控制

在命令行环境下，通过直接修改下列属性值，就可以打开/关闭 logcat 日志本地存储功能。

1.1 打开日志存储功能

setprop logd.logpersistd.enable true
setprop persist.logd.logpersistd.buffer all
setprop persist.logd.logpersistd logcatd

和通过 开发者选项 打开日志存储功能一样，修改上述属性值后，可以在 /data/misc/logd/ 目录下找到日志文件。
日志文件目录结构如下：

msmnile_gvmq:/ # ls /data/misc/logd
event-log-tags  logcat  logcat.001  logcat.002  logcat.003  logcat.id

1.2 关闭日志存储功能

setprop logd.logpersistd clear
setprop persist.logd.logpersistd.buffer ""
setprop logd.logpersistd.buffer ""
setprop logd.logpersistd.enable false

1.3 可能存在的问题

在极少数设备上，也出现过以上命令无法开关 logcat 日志存储功能的情况。原因暂未调查，但有可能是 selinux 权限未开放导致的。
如果你不幸碰到了，可以尝试用 setenforce 0 命令解除权限限制后再尝试上述命令修改属性值。

1.4 其它

对于 logd.logpersistd 和 persist.logd.logpersistd 这种命名很相似的属性，也许你会好奇他们有什么区别和联系。本文第三节关于各属性的描述对此进行了回答。此外，从文件 logcatd.rc 中，我们也能发现二者的关联：

......
on property:persist.logd.logpersistd=logcatd
    setprop logd.logpersistd logcatd
......
on property:logd.logpersistd.enable=true && property:logd.logpersistd=logcatd
    # log group should be able to read persisted logs
    mkdir /data/misc/logd 0750 logd log
    start logcatd

# stop logcatd service and clear data
on property:logd.logpersistd.enable=true && property:logd.logpersistd=clear
    setprop persist.logd.logpersistd ""
    stop logcatd
    # logd for clear of only our files in /data/misc/logd
    exec - logd log -- /system/bin/logcat -c -f /data/misc/logd/logcat -n ${logd.logpersistd.size:-256}
    setprop logd.logpersistd ""

# stop logcatd service
on property:logd.logpersistd=stop
    setprop persist.logd.logpersistd ""
    stop logcatd
    setprop logd.logpersistd ""

on property:logd.logpersistd.enable=false
    stop logcatd
......

文件格式比较简单，意图也很清楚，就是在各属性值发生变化时分别执行哪些操作。我就不一一解释了。

2. logd 支持的完整属性列表

除了上文提到的属性，logd 还能对别的属性值变化产生响应。
完整的属性列表可以在 Google 官方文档找到，见 /system/logging/logd/README.property。

不过原文档的说明比较简洁，所以现将其部分翻译和补充说明如下：

表中术语说明: