Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/orhanobut/logger

✔️ Simple, pretty and powerful logger for android
https://github.com/orhanobut/logger

android java json-logging log logcat logger pretty-printer timber

Last synced: about 2 months ago
JSON representation

✔️ Simple, pretty and powerful logger for android

Lists

README 

        
[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Logger-brightgreen.svg?style=flat)](http://android-arsenal.com/details/1/1658) [![](https://img.shields.io/badge/AndroidWeekly-%23147-blue.svg)](http://androidweekly.net/issues/issue-147)

[![Join the chat at https://gitter.im/orhanobut/logger](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/orhanobut/logger?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)  [![Build Status](https://travis-ci.org/orhanobut/logger.svg?branch=master)](https://travis-ci.org/orhanobut/logger)






### Logger

Simple, pretty and powerful logger for android



### Setup

Download

```groovy

implementation 'com.orhanobut:logger:2.2.0'

```



Initialize

```java

Logger.addLogAdapter(new AndroidLogAdapter());

```

And use

```java

Logger.d("hello");

```



### Output




### Options

```java

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

```java

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

```



Collections are supported (only available for debug logs)

```java

Logger.d(MAP);

Logger.d(SET);

Logger.d(LIST);

Logger.d(ARRAY);

```



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

```java

Logger.json(JSON_CONTENT);

Logger.xml(XML_CONTENT);

```



### Advanced

```java

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.

```java

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

```java

Logger.addLogAdapter(new DiskLogAdapter());

```



Add custom tag to Csv format strategy

```java

FormatStrategy formatStrategy = CsvFormatStrategy.newBuilder()

  .tag("custom")

  .build();

  

Logger.addLogAdapter(new DiskLogAdapter(formatStrategy));

```



### How it works




### More

- Use filter for a better result. PRETTY_LOGGER or your custom tag

- Make sure that wrap option is disabled

- You can also simplify output by changing settings.






- Timber Integration

```java

// 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.