• Stars
    star
    157
  • Rank 238,399 (Top 5 %)
  • Language
    Java
  • License
    MIT License
  • Created over 9 years ago
  • Updated over 8 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Ultimately minimal (yet very convenient) logger for Android and Java

Ultimately minimal (yet very convenient) logger for Android and Java.

Android Arsenal Build Status

Log is a super-simple drop-in replacement for android.util.Log that can also be used in normal Java projects.

Features

// API is backwards-compatible with android.util.Log, so you already know it.
Log.d(tag, "X equals " + x);

// Safe logging for multiple comma-separated values
Log.d(tag, "X", x)

// Tag is optional, by default it equals to the class name 
class Foo {
	public void foo() {
		Log.d("Hello"); // prints 'D/Foo: Hello'
	}
}

// If tag or TAG field is found - it overrides the class name
class Foo {
	private final static String tag = "Bar";
	public void foo() {
		Log.d("Hello"); // prints 'D/Bar: Hello'
	}
}

// And it's still compatible with your old code
class Foo {
	private final static String TAG = "Bar";
	public void foo() {
		Log.d(TAG, "Hello"); // prints 'D/Bar: Hello', not 'D/Bar: Bar Hello'
	}
}

// Even if you used different tag field names
class Foo {
	static {
		Log.useTags(new String[]{"tag", "TAG", "MYTAG", "_TAG", "iLoveLongFieldName"});
	}
	private final static String _TAG = "Bar";
	...
}

// Support for Throwables
Exception e = new Exception("foo");
Log.d("Something bad happened", someObject, "error:", e); // A log message and a stack trace will be printed

// Chainable API
Log
	.d("First")
	.d("Second")
	.d("Third line")

// Filters by log level
Log.level(Log.I);
Log.d("foo"); // will be ignored

// Format strings are suported, too
Log.useFormat(true);
Log.d("X equals %d", x); // prints 'X equals 42'
// But if no format is provided - log will be printed as multiple values
Log.d("Value of X", x); // prints 'Value of X 42'

// Long messages are wrapped on newlines
// If the message doesn't contain newlines and is longer than 4000 symbols
// (like compact JSONs or HTML) - it will be wrapped on whitespace or punctuation
Log.d("Hello\nworld"); // prints 'D/SomeTag: Hello' and 'D/SomeTag: world'

// On Android logs are printed via android.util.Log by default.
// On other JVMs logs are printed via System.out.println by default.
// Unless specified otherwise
Log.usePrinter(Log.SYSTEM, true).usePrinter(Log.ANDROID, false).d("hello"); // will be printed via System.out on Android as well
Log.usePrinter(mMyPrinter, true); // or you can use your own custom printers

// If you want to disable debug printing for Release build
if (!BuildConfig.DEBUG) {
  Log.usePrinter(Log.ANDROID, false); // from now on Log.d etc do nothing and is likely to be optimized with JIT
}

// And it's only a single class of 200 LOC, so don't be afraid that it will
// bloat your APK or slow down your builds.

Installation

build.gradle:

repositories {
	jcenter() // mavenCentral() would work, too
}
dependencies {
	compile 'co.trikita:log:1.1.5'
}

Migration from android.util.Log

If you already have a big project and want to use this logger right now - you can just change imports using 'sed' (Linux/Mac/Cygwin):

$ find -name "*.java" -type f -exec sed -i 's/import android.util.Log/import trikita.log.Log/g' {} \;

If you're using Android Studio: in the project pane right-click on the app/java directory (or any other directory containing your java classes). In the popup menu select "Replace in Path..." option.

'Text to find' should be "android.util.Log". 'Replace with' should be "trikita.log.Log". Click Find, click All files.

If you know an easier way (or for different IDE) - let me know.

How is it different from...

Here is a list of other popular loggers for Android: https://android-arsenal.com/tag/57

Most of them are too specific (logging to file or socket, or printing logs on screen). Some of them are too complicated (Twig, SLF4J and every other logger that has factories). But some of them are really nice, so that my logger was inspired by them.

These loggers are simple and put class and method names into the log message automatically. However they only support a single string parameter so you will end up with "X = "+x+", y="+y in most of your logs.

This two are very similar to my logger, but the first one is a bit bloated and the both don't support comma-separated values, only format-like strings:

And of course there are Jake Wharton's hugo and timber. Hugo is nice, but I didn't need to log/profile my methods, I only need to print log messages from time to time.

Timber was my favourite choice, but I don't use it because of the name. I understand that it's really clever, but my hands are too much used to start log lines with the letter "L", not "T". And timber also doesn't support comma-separated values, only format strings.

License

Code is distributed under MIT License

More Repositories

1

lorca

Build cross-platform modern desktop apps in Go + HTML5
Go
7,954
star
2

jsmn

Jsmn is a world fastest JSON parser/tokenizer. This is the official repo replacing the old one at Bitbucket
C
3,633
star
3

awfice

The world smallest office suite
HTML
3,462
star
4

fenster

The most minimal cross-platform GUI library
C++
513
star
5

tray

Cross-platform, super tiny C99 implementation of a system tray icon with a popup menu.
C
484
star
6

partcl

ParTcl - a micro Tcl implementation
C
467
star
7

metric

Minimal metrics for Go (counter/gauge/histogram). No dependencies. Compatible with expvar. Web UI included.
Go
353
star
8

luash

Tiny lua module to write shell scripts with lua (inspired by Python's sh module)
Lua
302
star
9

pt

Protothreads (coroutines) in C99. Highly portable, but work best in low-end embedded systems.
C
267
star
10

o

Tiny and simple React clone
JavaScript
249
star
11

lua-promises

A+ promises in Lua
Lua
216
star
12

tojvm

A toy JVM in Go
Go
156
star
13

webview-python

Python bindings to webview
Objective-C
151
star
14

bfapi

Resilient, scalable Brainf*ck, in the spirit of modern systems design
Go
144
star
15

nokia-composer

Nokia Composer in 512 bytes
HTML
125
star
16

expr

Fast and lightweight math expression evaluator in C99
C
119
star
17

hid

Simple HID driver for Go (pure golang, no dependencies, no cgo)
Go
119
star
18

zs

Absolutely minimal static site generator in Go (powers https://zserge.com)
Go
91
star
19

tinysh

Tiny UNIX shell, de-obfuscated, modernized, and "rewritten in Rust".
C
88
star
20

nanonn

A nano-framework for neural networks
Rust
83
star
21

dotfiles

git clone --bare https://github.com/zserge/dotfiles $HOME/.dotfiles && git --git-dir=$HOME/.dotfiles/ --work-tree=$HOME checkout
Vim Script
79
star
22

lc3-forth

Post-Apocalyptic Computing: bootstrapping Forth environment for LC-3 CPU
C
79
star
23

1bitr

Minimalistic text-based 1-bit music tracker
C
73
star
24

carnatus

A tiny chess engine in Go (sunfish port)
Go
65
star
25

odetoj

Rewrite of Arthur Whitney's one-page J interpreter in Rust
Rust
61
star
26

headline

Ascetic RSS reader in JavaScript, no server required
JavaScript
57
star
27

glob-grep

A little experiment: compare the languages aimed to replace C
Zig
52
star
28

buckbone

A simple android project generator for the Buck build system
Shell
52
star
29

q

Tiny and simple VueJS clone
JavaScript
46
star
30

beep

Cross-platform beep() function
C
43
star
31

slide

An attempt to implement Trikita Slide for desktop
C++
39
star
32

figma-simplify-path

Figma plugin to simplify vector paths
JavaScript
26
star
33

mucks

A tiny terminal session manager for Tmux, Screen and DVTM
Shell
20
star
34

anvil-kotlin-demos

Minimal tutorial/demos for Anvil+Kotlin
Kotlin
18
star
35

zserge.github.io

My static site
HTML
14
star
36

kv

An ultimately minimal persistent key-value store + LRU cache
Go
12
star
37

jsmn.lua

The world fastest JSON parser ported to Lua
Lua
11
star
38

aint

Code for the "AI or AIN'T" blog posts
Go
11
star
39

yu

Yu is a tee-like tool, but with rotation feature like logrotate
C
10
star
40

tab

🎼 A tiny CLI tool to render tabs for music instruments (🎹🎷🎺🎸🪕🪈 and many others!)
C
9
star
41

bsoz

One of the most minimal MOS6502 and retro computer emulators!
C
8
star
42

mdns

Very pragmatic mDNS implementation in Go
Go
8
star
43

kveer

A tiny in-memory key-value storage in Go with optional persistence (atomic backup file, or append-only)
Go
7
star
44

bf

Well, everyone has to write a brainf*ck interpreter at some point
C
7
star
45

covered

Trello Cover Card Generator
JavaScript
6
star
46

toy-java-agent

Toy Java agent
Java
6
star
47

atomicwriter

Atomic file writes in Go (using a unique temporary file and atomic rename)
Go
5
star
48

lex

A library for writing lexers in Go
Go
4
star
49

textizer

Minimal android widgets in Scheme
Java
4
star
50

chess

JavaScript
4
star
51

ping

An ultimately minimal social network, messaging, pub/sub and home automation app
4
star
52

tinylangs

Real programming langauges in 50 lines of code
Python
4
star
53

photo

Minimalistic private photo booth
HTML
3
star
54

incr

incr.it backend
JavaScript
3
star
55

zine

Tiny CSS template to produce micro-zines (folded 8-page magazines)
Python
3
star
56

one-click-hugo-cms

CSS
2
star
57

grafana-zero

Python
2
star
58

gif

Simple GIF recorder
HTML
2
star
59

protoc-gen-micro

Protobuf code generation for micro
Go
2
star
60

scaffold

Templates for quick project start
Java
1
star
61

r

Something that rhymes. Or not.
1
star