timber README

The project's README from github.com/JakeWharton/timber. As one markdown file: README.md.

Timber

This is a logger with a small, extensible API which provides utility on top of Android's normal Log class.

I copy this class into all the little apps I make. I'm tired of doing it. Now it's a library.

Behavior is added through Tree instances. You can install an instance by calling Timber.plant. Installation of Trees should be done as early as possible. The onCreate of your application is the most logical choice.

The DebugTree implementation will automatically figure out from which class it's being called and use that class name as its tag. Since the tags vary, it works really well when coupled with a log reader like Pidcat.

There are no Tree implementations installed by default because every time you log in production, a puppy dies.

Usage

Two easy steps:

  1. Install any Tree instances you want in the onCreate of your application class.
  2. Call Timber's static methods everywhere throughout your app.

Check out the sample app in timber-sample/ to see it in action.

Lint

Timber ships with embedded lint rules to detect problems in your app.

Download

repositories {
  mavenCentral()
}

dependencies {
  implementation 'com.jakewharton.timber:timber:5.0.1'
}

Documentation is available at jakewharton.github.io/timber/docs/5.x/.

Snapshots of the development version are available in Sonatype's snapshots repository. 

repositories {
  mavenCentral()
  maven {
    url 'https://central.sonatype.com/repository/maven-snapshots/'
  }
}

dependencies {
  implementation 'com.jakewharton.timber:timber:5.1.0-SNAPSHOT'
}

Snapshot documentation is available at jakewharton.github.io/timber/docs/latest/.

License

Copyright 2013 Jake Wharton

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

timber (JakeWharton/timber)

Searching Database…

10.9K ·GitHub
Timber
Что это такое?Timber — это логгер с небольшим расширяемым API, который работает поверх встроенного класса Log в Android. Поведение добавляется через подключение экземпляров Tree, а не вызовом Log.d/Log.e напрямую.
Это самостоятельное приложение или библиотека, которую я добавляю в свой проект?Это библиотека, которую подключают к Android-приложению. По умолчанию в ней не установлено ни одной реализации Tree, поэтому она ничего не логирует, пока вы не подключите хотя бы один Tree.
Как начать использовать её в своём приложении?Подключите нужные экземпляры Tree (например, DebugTree) в onCreate вашего класса Application, а затем вызывайте статические методы Timber (Timber.d, Timber.e и т. д.) в любом месте приложения.
Работает ли это вне Android-приложений?Нет. Timber создан специально как обёртка над классом Log из Android, поэтому он предназначен для проектов под Android.
Будет ли что-то логироваться, если я просто добавлю зависимость без дополнительной настройки?Нет. Timber молчит, пока вы явно не подключите Tree (например, DebugTree). Библиотека намеренно поставляется без включённых по умолчанию логирующих Tree.
Что делает встроенный DebugTree?DebugTree автоматически определяет, из какого класса его вызвали, и использует имя этого класса как тег лога. Это хорошо сочетается с программами для просмотра логов, например Pidcat.
Что проверяет правило TimberArgCount?Timber включает встроенное правило Android Lint, которое отмечает вызовы Timber, где количество аргументов не совпадает с плейсхолдерами в строке формата, например когда передан один аргумент для строки, ожидающей два.
Зачем использовать Timber вместо прямого вызова Log?Timber даёт небольшой расширяемый API, в котором поведение логирования задаётся подключаемыми классами Tree. Он сам проставляет теги для вызовов и по умолчанию не оставляет отладочные логи в релизных сборках.
What are similar projects?logger, GSYVideoPlayer, MaterialDrawer, Shizuku, platform_frameworks_base, MVPArms, leakcanary, DoKit
Which topics is it in?logger, lint, android-development, android-library, logging, debugging, mobile-development, static-analysis, kotlin, sdk, utility, java
Creator
JakeWharton
Size
2.8 MB
Stars
10.9K
Updated
CommitOct 16Release5.0.1Aug 13
Age
13y
Commits · 90 Days