Logcat 命令行工具

Logcat 是一款命令行工具，它会转储系统消息的日志，包括您使用 Log 类从应用中写入的消息。

此页面介绍的是命令行 logcat 工具，但您也可以在 Android Studio 的 **Logcat** 窗口中查看日志消息。有关在 Android Studio 中查看和过滤日志的信息，请参阅 使用 Logcat 查看和写入日志。

日志系统概述

Android 日志系统是由系统进程 logd 维护的一组结构化循环缓冲区。可用缓冲区的数量是固定的，并由系统定义。最相关的缓冲区是

• main：存储大多数应用日志。
• system：存储源自 Android 操作系统的消息。
• crash：存储崩溃日志。每个日志条目都具有优先级、标识日志来源的标签以及实际的日志消息。

日志系统的首要 C/C++ 接口是共享库 liblog 及其标头 <android/log.h>。所有特定于语言的日志记录工具（包括 android.util.Log）最终都会调用函数 __android_log_write。默认情况下，它会调用函数 __android_log_logd_logger，该函数使用套接字将日志条目发送到 logd。从 API 级别 30 开始，可以通过调用 __android_set_log_writer 来更改日志记录函数。更多信息可在 NDK 文档 中找到。

adb logcat 显示的日志会经过四个级别的过滤

编译时过滤

根据编译设置，某些日志可能会从二进制文件中完全删除。例如，可以将 ProGuard 配置为从 Java 代码中删除对 Log.d 的调用。

系统属性过滤

liblog 会查询一组系统属性以确定要发送到 logd 的最低严重性级别。如果您的日志具有标签 MyApp，则会检查以下属性，并预期它们包含最低严重性的第一个字母（V、D、I、W、E 或 S 用于禁用所有日志）

• log.tag.MyApp
• persist.log.tag.MyApp
• log.tag
• persist.log.tag

应用过滤

如果未设置任何属性，liblog 将使用 __android_log_set_minimum_priority 设置的最低优先级。默认设置为 INFO。

显示过滤

adb logcat 支持其他过滤器，这些过滤器可以减少从 logd 显示的日志数量。有关更多详细信息，请参阅关于 过滤日志输出 的部分。

命令行语法

要通过 adb shell 运行 logcat，一般用法如下：

[adb] shell logcat [<option>] ... [<filter-spec>] ...

还有一种 adb logcat 的简写形式，但这只是扩展到 adb shell logcat。

选项

logcat 具有许多选项。可用的选项将取决于您使用的设备的操作系统版本。要查看您使用的设备特有的 logcat 帮助信息，请执行以下操作：

    adb logcat --help
    

请注意，由于 logcat 既是面向操作系统开发者也是面向应用开发者的工具（应用开发者预期使用 Android Studio），因此许多选项只能以 root 身份使用。

过滤日志输出

日志消息的标签是一个短字符串，指示消息来源的系统组件。例如，视图系统的“View”。

优先级是以下字符值之一，从最低优先级到最高优先级排序

要获取系统中使用的带有优先级的标签列表，请运行logcat并观察每条消息的前两列，格式为<priority>/<tag>。

以下是使用logcat -v brief output命令获得的简短logcat输出示例。输出显示消息与优先级级别“I”和标签“ActivityManager”相关。

I/ActivityManager(  585): Starting activity: Intent { action=android.intent.action...}

为了将日志输出减少到可管理的级别，请使用*过滤器表达式*来限制日志输出。过滤器表达式允许您向系统指示您感兴趣的标签-优先级组合。系统会抑制指定标签的其他消息。

过滤器表达式的格式如下：tag:priority ...，其中tag表示感兴趣的标签，priority表示该标签要报告的最低优先级级别。该标签的优先级等于或高于指定优先级的消息将写入日志。在一个过滤器表达式中可以提供任意数量的tag:priority规范。这些规范由空格分隔。

以下是一个过滤器表达式的示例，它会抑制所有日志消息，除了那些标签为“ActivityManager”且优先级为“Info”或更高的消息，以及那些标签为“MyApp”且优先级为“Debug”或更高的消息。

adb logcat ActivityManager:I MyApp:D *:S

前面表达式中的最后一个元素*:S将所有标签的优先级级别设置为“静默”，这确保只显示带有“ActivityManager”和“MyApp”的日志消息。使用*:S可以确保日志输出仅限于您明确指定的过滤器。*:S允许您的过滤器充当日志输出的白名单。

注意：在某些shell中，“*”字符由shell保留。如果您使用的是此类shell，请将过滤器表达式用引号括起来：adb logcat "ActivityManager:I MyApp:D *:S"

以下过滤器表达式将显示所有标签上优先级级别为“警告”及更高的所有日志消息。

adb logcat *:W

如果您是从开发计算机运行logcat而不是在远程adb shell上运行它，您还可以通过为环境变量ANDROID_LOG_TAGS导出值来设置默认过滤器表达式。

export ANDROID_LOG_TAGS="ActivityManager:I MyApp:D *:S"

如果您是从远程shell运行logcat或使用adb shell logcat，则不会将ANDROID_LOG_TAGS过滤器导出到模拟器/设备实例。

控制日志输出格式

除了标签和优先级之外，日志消息还包含许多元数据字段。您可以修改消息的输出格式，以便它们显示特定的元数据字段。为此，请使用-v选项并指定以下支持的输出格式之一。

• brief：显示优先级、标签和发出消息的进程的PID。
• long：显示所有元数据字段，并用空行分隔消息。
• process：仅显示PID。
• raw：显示原始日志消息，不包含其他元数据字段。
• tag：仅显示优先级和标签。
• thread：一种旧格式，显示优先级、PID和发出消息的线程的TID。
• threadtime（默认）：显示日期、调用时间、优先级、标签、PID和发出消息的线程的TID。
• time：显示日期、调用时间、优先级、标签和发出消息的进程的PID。

启动logcat时，请使用-v选项指定所需的输出格式。

[adb] logcat [-v <format>]

这是一个显示如何生成thread输出格式的消息的示例。

adb logcat -v thread

您只能使用-v选项指定一个输出格式。但是，您可以根据需要指定任意数量的修饰符，只要它们有意义即可。logcat会忽略没有意义的修饰符。

格式修饰符

格式修饰符会更改logcat输出。要指定格式修饰符，请使用-v选项，如下所示。

adb logcat -b all -v color -d

每个Android日志消息都关联着一个标签和一个优先级。您可以将任何格式修饰符与以下任何格式选项组合。

• brief
• long
• process
• raw
• tag
• thread
• threadtime
• time

要设置以下修饰符的详细信息，请在命令行输入logcat -v --help。

• color：使用不同的颜色显示每个优先级级别。
• descriptive：显示日志缓冲区事件描述。此修饰符仅影响事件日志缓冲区消息，对其他非二进制缓冲区没有影响。事件描述来自event-log-tags数据库。
• epoch：以自1970年1月1日开始的秒数显示时间。
• monotonic：以自上次启动以来的CPU秒数显示时间。
• printable：确保任何二进制日志内容都已转义。
• uid：如果访问控制允许，则显示已记录进程的UID或Android ID。
• usec：以微秒精度显示时间。
• UTC：以UTC显示时间。
• year：在显示的时间中添加年份。
• zone：在显示的时间中添加本地时区。

查看替代日志缓冲区

Android日志系统为日志消息保留多个循环缓冲区，并非所有日志消息都发送到默认循环缓冲区。要查看其他日志消息，请使用-b选项运行logcat命令以请求查看替代循环缓冲区。您可以查看任何这些替代缓冲区。

• radio：查看包含无线电/电话相关消息的缓冲区。
• events：查看已解释的二进制系统事件缓冲区消息。
• main：查看主日志缓冲区（默认），其中不包含系统和崩溃日志消息。
• system：查看系统日志缓冲区（默认）。
• crash：查看崩溃日志缓冲区（默认）。
• all：查看所有缓冲区。
• default：报告main、system和crash缓冲区。

-b选项的用法是：

[adb] logcat [-b <buffer>]

以下是如何查看包含无线电和电话消息的日志缓冲区的示例。

adb logcat -b radio

要为要打印的所有缓冲区指定多个-b标志，请输入以下内容：

logcat -b main -b radio -b events

指定一个-b标志，其中包含以逗号分隔的缓冲区列表，例如：

logcat -b main,radio,events

从代码记录日志

Log类允许您在代码中创建日志条目，这些条目显示在logcat工具中。常用的日志记录方法包括：

• Log.v(String, String)（详细）
• Log.d(String, String)（调试）
• Log.i(String, String)（信息）
• Log.w(String, String)（警告）
• Log.e(String, String)（错误）

例如，使用以下调用：

Log.i("MyActivity", "MyClass.getView() — get item number $position")

Log.i("MyActivity", "MyClass.getView() — get item number " + position);

logcat输出类似于以下内容：

I/MyActivity( 1557): MyClass.getView() — get item number 1