Herramienta de línea de comandos Logcat

Logcat es una herramienta de línea de comandos que vuelca un registro de mensajes del sistema, incluidos los que escribiste desde tu app con la clase Log.

En esta página, se explica la herramienta de línea de comandos logcat, pero también puedes ver mensajes de registro en la ventana Logcat de Android Studio. Si quieres obtener información para ver y filtrar registros desde Android Studio, consulta Cómo ver y escribir registros con Logcat.

Descripción general del sistema de registro

El sistema de registro de Android es un conjunto de búferes circulares estructurados que mantiene el proceso del sistema logd. El sistema fija y define el conjunto de búferes disponibles. Los búferes más relevantes son los siguientes:

• main: Almacena la mayoría de los registros de la aplicación.
• system: Almacena mensajes que se originan en el SO Android.
• crash: Almacena registros de fallas. Cada entrada de registro tiene una prioridad, una etiqueta que identifica el origen del registro y el mensaje de registro real.

La interfaz principal de C/C++ para el sistema de registro es la biblioteca compartida liblog y su encabezado <android/log.h>. Todas las utilidades de registro específicas de lenguaje (lo que incluye android.util.Log) finalmente llaman a la función __android_log_write. De forma predeterminada, llama a la función __android_log_logd_logger, que envía la entrada de registro a logd mediante un socket. A partir del nivel de API 30, se puede cambiar la función de registro llamando a __android_set_log_writer. Puedes encontrar más información en la documentación del NDK.

Los registros que muestra adb logcat se someten a cuatro niveles de filtrado:

Filtrado en tiempo de compilación

Según los parámetros de configuración de compilación, es posible que algunos registros se quiten por completo del objeto binario. Por ejemplo, se puede configurar ProGuard para quitar llamadas a Log.d del código Java.

Filtrado de propiedades del sistema

liblog consulta un conjunto de propiedades del sistema para determinar el nivel de gravedad mínimo que se enviará a logd. Si tus registros tienen la etiqueta MyApp, se verifican las propiedades indicadas a continuación, las cuales deberían contener la primera letra de la gravedad mínima (V, D, I, W, E o S para inhabilitar todos los registros):

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

Filtrado de aplicaciones

Si no se configura ninguna de las propiedades, liblog usa la prioridad mínima establecida por __android_log_set_minimum_priority. El parámetro de configuración predeterminado es INFO.

Filtrado de visualización

adb logcat admite filtros adicionales que pueden reducir la cantidad de registros que se muestran en logd. Consulta la sección para filtrar resultados de registros si quieres obtener más detalles.

Sintaxis de la línea de comandos

Para ejecutar logcat a través del shell adb, el uso general es el siguiente:

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

También hay una abreviatura de adb logcat, pero eso solo se expande a adb shell logcat.

Opciones

logcat tiene muchas opciones. Las opciones disponibles dependerán de la versión del SO del dispositivo que uses. Para ver la ayuda de logcat específica para el dispositivo que estás usando, ejecuta lo siguiente:

    adb logcat --help
    

Ten en cuenta que logcat es una herramienta para desarrolladores de SO y de apps. (y se espera que los desarrolladores de apps usen Android Studio) muchas de las opciones son solo utilizable como root.

Cómo filtrar los resultados de los registros

La etiqueta de un mensaje de registro es una string corta que indica el componente del sistema donde se origina el mensaje. Por ejemplo, "View" para el sistema de vista.

La prioridad es uno de los siguientes valores de caracteres ordenados de la prioridad más baja a la más alta:

Para obtener una lista de las etiquetas que se usan en el sistema con prioridades, ejecuta logcat y observa las dos primeras columnas de cada mensaje, indicadas como <priority>/<tag>.

El siguiente es un ejemplo de un breve resultado de logcat obtenido con el comando logcat -v brief output. El resultado muestra que el mensaje se relaciona con el nivel de prioridad "I" y la etiqueta "ActivityManager":

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

Para reducir los resultados del registro a un nivel fácil de manejar, restringe los resultados del registro usando expresiones de filtro. Las expresiones de filtro te permiten indicar al sistema las combinaciones de prioridad de etiqueta que te interesan. El sistema elimina otros mensajes para las etiquetas especificadas.

Una expresión de filtro tiene este formato tag:priority ..., en el que tag indica la etiqueta de interés y priority indica el nivel de prioridad mínimo que se debe informar para esa etiqueta. Los mensajes para esa etiqueta que posean el nivel de prioridad especificado o un nivel superior se escriben en el registro. Proporciona cualquier cantidad de especificaciones tag:priority en una sola expresión de filtro. Las series de especificaciones están delimitadas por espacios en blanco.

A continuación, se muestra un ejemplo de una expresión de filtro que suprime todos los mensajes del registro, excepto aquellos con la etiqueta "ActivityManager" con prioridad "Info" o más alta y aquellos con la etiqueta "MyApp" con prioridad "Debug" o más alta:

adb logcat ActivityManager:I MyApp:D *:S

El elemento final en la expresión anterior, *:S, fija el nivel de prioridad para todas las etiquetas en "silent", lo cual garantiza que solo se muestren los mensajes de registro con "ActivityManager" y "MyApp". El uso de *:S garantiza que el resultado del registro se restrinja a los filtros que especificaste de forma explícita. *:S permite que tus filtros sirvan como una lista de entidades permitidas para el resultado del registro.

Nota: En algunos shells, el shell se reserva el carácter "*". Si usas ese shell, encierra la expresión de filtro entre comillas: adb logcat "ActivityManager:I MyApp:D *:S".

La siguiente expresión de filtro muestra todos los mensajes del registro con nivel de prioridad "warning" o superior en todas las etiquetas:

adb logcat *:W

Si estás ejecutando logcat desde tu computadora de desarrollo en lugar de ejecutarla en un shell remoto adb también puedes establecer una expresión de filtro predeterminada si exportas un valor para la variable de entorno ANDROID_LOG_TAGS:

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

El filtro ANDROID_LOG_TAGS no se exporta a la instancia del emulador o dispositivo si ejecutas logcat desde un shell remoto o con adb shell logcat.

Cómo controlar el formato de los resultados de los registros

Los mensajes de registro contienen varios campos de metadatos además de la etiqueta y la prioridad. Puedes modificar el formato de salida para los mensajes de modo que muestren un campo de metadatos específico. Para ello, usa la opción -v y especifica uno de los siguientes formatos de salida admitidos:

• brief: Muestra la prioridad, la etiqueta y el PID del proceso que emite el mensaje.
• long: Muestra todos los campos de metadatos y mensajes separados por líneas en blanco.
• process: Muestra solo el PID.
• raw: Muestra el mensaje del registro sin formato y sin otros campos de metadatos.
• tag: Muestra la prioridad y la etiqueta únicamente.
• thread:: Es un formato heredado que muestra la prioridad, el PID y el TID del subproceso que emite el mensaje.
• threadtime (opción predeterminada): Muestra la fecha, la hora de invocación, la prioridad, la etiqueta, el PID y el TID del subproceso que emite el mensaje.
• time: Muestra la fecha, la hora de invocación, la prioridad y la etiqueta, y el PID del proceso que emite el mensaje.

Cuando inicies logcat, especifica el formato de salida que quieras con la opción -v:

[adb] logcat [-v <format>]

A continuación, te mostramos un ejemplo de generación de mensajes con formato de salida thread:

adb logcat -v thread

Solo puedes especificar un formato de salida con la opción -v. Sin embargo, puedes especificar todos los modificadores que necesites, siempre que tengan sentido. logcat ignora los modificadores que no tienen sentido.

Modificadores de formato

Los modificadores de formato cambian el resultado de logcat. Para especificar un modificador de formato, usa la opción -v de la siguiente manera:

adb logcat -b all -v color -d

Todos los mensajes de registro de Android tienen una etiqueta y una prioridad asociadas a ellos. Puedes combinar cualquier modificador de formato con cualquiera de las siguientes opciones de formato:

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

Para dar formato a los siguientes detalles del modificador, ingresa logcat -v --help en la línea de comandos:

• color: Muestra cada nivel de prioridad con un color diferente.
• descriptive: Muestra descripciones de eventos de búferes de registro. Este modificador afecta solo a los mensajes del búfer del registro de eventos y no funciona con otros búferes no binarios. Las descripciones de eventos provienen de la base de datos de etiquetas de registro de eventos.
• epoch: Muestra la hora en segundos a partir del 1 de enero de 1970.
• monotonic: Muestra el tiempo en segundos de la CPU a partir del último inicio.
• printable: Garantiza que se escape cualquier contenido de registro binario.
• uid: Si los controles de acceso lo permiten, muestra el UID o ID de Android del proceso registrado.
• usec: Muestra la hora, con precisión en microsegundos.
• UTC: Muestra la hora como UTC.
• year: Agrega el año a la hora que se muestra.
• zone: Agrega la zona horaria local a la hora que se muestra.

Cómo ver los búferes de registro alternativos

El sistema de registro de Android mantiene varios búferes circulares para los mensajes de registro, y no todos los mensajes de registro se envían al búfer circular predeterminado. Para ver mensajes de registro adicionales, ejecuta el comando logcat con la opción -b a fin de solicitar la visualización de un búfer circular alternativo. Puedes ver cualquiera de los siguientes búferes alternativos:

• radio: Muestra el búfer que contiene mensajes de radio y telefonía.
• events: Muestra los mensajes del búfer de eventos del sistema binario interpretados.
• main: Muestra el búfer de registro principal (predeterminado), que no contiene mensajes de registro de fallas ni del sistema.
• system: Muestra el búfer de registro del sistema (predeterminado).
• crash: Muestra el búfer de registro de fallas (predeterminado).
• all: Muestra todos los búferes.
• default: Muestra informes de los búferes main, system y crash.

La utilidad de la opción -b es la siguiente:

[adb] logcat [-b <buffer>]

A continuación, te mostramos un ejemplo de visualización de un búfer de registro que contiene mensajes de radio y telefonía:

adb logcat -b radio

A fin de especificar varias marcas -b para todos los búferes que deseas imprimir, ingresa lo siguiente:

logcat -b main -b radio -b events

Especifica una sola marca -b con una lista de búferes separados por comas, por ejemplo:

logcat -b main,radio,events

Registro desde el código

La clase Log te permite crear entradas de registro en tu código que se muestran en la herramienta de logcat. Entre los métodos de registro comunes se incluyen los siguientes:

• Log.v(String, String) (registro detallado)
• Log.d(String, String) (depuración)
• Log.i(String, String) (información)
• Log.w(String, String) (advertencia)
• Log.e(String, String) (error)

Por ejemplo, usando la siguiente llamada:

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

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

logcat genera un resultado similar al siguiente:

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