Install Timber via Gradle
trunkAdd Maven Central to your repositories and include the Timber dependency in your build.gradle file.
repositories {
mavenCentral()
}
dependencies {
implementation 'com.jakewharton.timber:timber:5.0.1'
}Timber Documentation
repository·trunk·Indexed 27 days ago
https://github.com/jakewharton/timberAn extensible logging utility for Android that provides a small API on top of the standard Android Log class. It utilizes a Tree-based system for behavior configuration and includes embedded lint rules to prevent common logging mistakes, such as incorrect exception logging patterns and unnecessary string concatenation.
What's inside Timber
Configure Timber usage
trunkTimber works by planting
Treeinstances. Behavior is added through these trees.- Plant Trees: Call
Timber.plant(tree)as early as possible in your application lifecycle, typically in theonCreatemethod of yourApplicationclass. - Log Messages: Use Timber's static methods throughout your application to log messages.
Note:
DebugTreeis a common implementation that automatically determines the calling class name to use as a tag.- Plant Trees: Call
Use Timber Formatting instead of String Concatenation
trunkTo avoid unnecessary string allocations and to follow best practices, use Timber's built-in string formatting instead of using the+operator for string concatenation in log calls.Correct Timber Exception Logging Pattern
trunkWhen logging an exception with Timber, you should pass theThrowableas the first argument. Additionally, do not explicitly include the exception's message in the log string, as this is redundant and handled by Timber.Reference Timber embedded Lint rules
trunkTimber includes embedded lint rules to help prevent common logging mistakes and ensure optimal performance and formatting.Timber Lint Issues and Rules
trunkThetimber-lintmodule provides several Android Lint rules to ensure correct usage of the Timber logging library. These rules catch common mistakes regarding argument counts, types, and redundant logging patterns.