com.airg.android.logging

Class LogCatcher

java.lang.Object

com.airg.android.logging.LogCatcher

public final class LogCatcher
extends java.lang.Object

Allows for capturing the android system log.

Notes:

• This is an experimental class and most definitely full of bugs. Approach with caution!
• If you have any services in your android manifest that run in their own process, filtering the log by pid will only capture the log output from the process that instantiates the LogCatcher instance. If you need to capture the output from all your processes, you will have to instantiate one LogCatcher instance per process and capture the logs separately.
• The capture and clear tasks run asynchronously (as you can tell from the callbacks). There is a noticeable delay between when you write to log and when it actually appears in the log. If certain log entries MUST be captured, you'd want to hold off on ending a capture session until everything has been 'seen' in LogCatcher.OnLogLinesListener.onLogLine(String). If it's not there, it's not captured yet.

See Also:

https://developer.android.com/studio/command-line/logcat.html.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LogCatcher.OnLogLinesListener receive log lines and updates on the capture state

Constructor Summary

Constructors

Constructor and Description
LogCatcher() Default constructor.
LogCatcher(boolean clear) Constructor.
LogCatcher(boolean clear, boolean self) Constructor.
LogCatcher(boolean clear, boolean self, java.util.concurrent.Executor executor) Constructor.
LogCatcher(boolean clear, int processId, java.util.concurrent.Executor executor) Constructor.

Method Summary

Modifier and Type	Method and Description
void	clear() Best effort log eraser.
static void	clearLog() Best effort log eraser.
void	dump(LogCatcher.OnLogLinesListener listener) Capture the current log lines.
void	endCapture() Stop capturing log output
void	startCapture(LogCatcher.OnLogLinesListener listener) Starts to capture the log lines until endCapture() is called.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LogCatcher

public LogCatcher(boolean clear,
                  int processId,
                  java.util.concurrent.Executor executor)

Constructor. Allows the caller to specify whether to clear the log, the process id, and an executor for background tasks.

Parameters:

clear - specify true to clear the log, or false to leave the log untouched.

processId - Specify a process id on which to filter the log.

executor - An Executor on which to execute background tasks on. If null is provided, the default background executor is obtained via Executors.newSingleThreadExecutor()

LogCatcher

public LogCatcher(boolean clear,
                  boolean self,
                  java.util.concurrent.Executor executor)

Constructor. Allows the caller to specify whether to clear the log, collect only self logs, and an executor for background tasks.

Parameters:

clear - specify true to clear the log, or false to leave the log untouched.

self - specify true to capture only the log lines from your own application, or false to capture the entire log.

executor - An Executor on which to execute background tasks on

LogCatcher

public LogCatcher(boolean clear,
                  boolean self)

Constructor. Allows the caller to specify whether to clear the log and whether to collect global or only self logs.

Parameters:

clear - specify true to clear the log, or false to leave the log untouched.

self - specify true to capture only the log lines from your own application, or false to capture the entire log.

LogCatcher

public LogCatcher()

Default constructor. Will not clear the log, captures globally, and runs tasks on a default background executor.

LogCatcher

public LogCatcher(boolean clear)

Constructor. Allows the caller to choose whether or not to clear the log, captures globally, and runs tasks on a default background executor.

Parameters:

clear - specify true to clear the log, or false to leave the log untouched.

Method Detail

dump

public void dump(LogCatcher.OnLogLinesListener listener)

Capture the current log lines. This method produces the equivalent of adb logcat -d

Parameters:

listener - a listener to receive log lines on the same thread that is executing the capture (e.g. your provided executor. If you didn't provide one, this is a background thread).

startCapture

public void startCapture(LogCatcher.OnLogLinesListener listener)

Starts to capture the log lines until endCapture() is called.

Parameters:

listener - A listener to receive log lines as they are logged.

endCapture

public void endCapture()

Stop capturing log output

clearLog

public static void clearLog()

Best effort log eraser. No instance needed.

clear

public void clear()

Best effort log eraser.