logger README

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

Android Arsenal Join the chat at https://gitter.im/orhanobut/logger Build Status

Logger

Simple, pretty and powerful logger for android

Setup

Download

implementation 'com.orhanobut:logger:2.2.0'

Initialize

Logger.addLogAdapter(new AndroidLogAdapter());

And use

Logger.d("hello");

Output

Options

Logger.d("debug");
Logger.e("error");
Logger.w("warning");
Logger.v("verbose");
Logger.i("information");
Logger.wtf("What a Terrible Failure");

String format arguments are supported

Logger.d("hello %s", "world");

Collections are supported (only available for debug logs)

Logger.d(MAP);
Logger.d(SET);
Logger.d(LIST);
Logger.d(ARRAY);

Json and Xml support (output will be in debug level)

Logger.json(JSON_CONTENT);
Logger.xml(XML_CONTENT);

Advanced

FormatStrategy formatStrategy = PrettyFormatStrategy.newBuilder()
  .showThreadInfo(false)  // (Optional) Whether to show thread info or not. Default true
  .methodCount(0)         // (Optional) How many method line to show. Default 2
  .methodOffset(7)        // (Optional) Hides internal method calls up to offset. Default 5
  .logStrategy(customLog) // (Optional) Changes the log strategy to print out. Default LogCat
  .tag("My custom tag")   // (Optional) Global tag for every log. Default PRETTY_LOGGER
  .build();

Logger.addLogAdapter(new AndroidLogAdapter(formatStrategy));

Loggable

Log adapter checks whether the log should be printed or not by checking this function. If you want to disable/hide logs for output, override isLoggable method. true will print the log message, false will ignore it.

Logger.addLogAdapter(new AndroidLogAdapter() {
  @Override public boolean isLoggable(int priority, String tag) {
    return BuildConfig.DEBUG;
  }
});

Save logs to the file

//TODO: More information will be added later

Logger.addLogAdapter(new DiskLogAdapter());

Add custom tag to Csv format strategy

FormatStrategy formatStrategy = CsvFormatStrategy.newBuilder()
  .tag("custom")
  .build();
  
Logger.addLogAdapter(new DiskLogAdapter(formatStrategy));

How it works

More

// Set methodOffset to 5 in order to hide internal method calls
Timber.plant(new Timber.DebugTree() {
  @Override protected void log(int priority, String tag, String message, Throwable t) {
    Logger.log(priority, tag, message, t);
  }
});

License

Copyright 2018 Orhan Obut

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.

logger (orhanobut/logger)

Searching Database…

13.8K ·GitHub
Logger
What is this?Logger is a simple, pretty, and powerful logging library for Android that makes Logcat output easier to read.
Is this a standalone app or a library I add to an Android project?It's an Android/Java/Kotlin library you include as a dependency and initialize in your app code — it has no UI or app of its own.
How do I add it to my Android project?Download the library (add it as a dependency), initialize Logger once in your app, then call its log methods wherever you want formatted output.
How is Logger's output different from plain Android Log calls?Based on its GitHub topics ('pretty-printer', 'json-logging'), Logger formats output with structured borders and can pretty-print JSON, making logs much easier to scan in Logcat than raw Log.d output.
Is it similar to Jake Wharton's Timber library?The repo lists 'timber' as a related topic, suggesting Logger plays a similar role — a drop-in wrapper over Android's Log class — but with an emphasis on pretty-printed and JSON-formatted output.
Does it work for both Java and Kotlin Android projects?Yes, the library itself is written in Kotlin and its topics include both 'java' and 'kotlin', so Android apps written in either language can use it.
What are similar projects?timber, loguru, leakcanary, MPAndroidChart, Luban, EventBus, GSYVideoPlayer, flexbox-layout
Which topics is it in?logger, log, android-library, logging, lightweight, debugging, mobile-development, kotlin, json, java, mobile, android
Creator
orhanobut
Size
1.9 MB
Stars
13.8K
Updated
CommitOct 03Release2.2.0Mar 24
Age
11y
Commits · 90 Days