gordonhart/safe-logging

Interfaces and utilities for safe log messages

License

This repository is made available under the Apache 2.0 License.

Safe-Logging

Interfaces and utilities for safe log messages.

Usage

Add dependency to gradle:

compile "com.palantir.safe-logging:safe-logging"

Annotate log messages with named SafeArg and UnsafeArg as appropriate. For example:

// previously
log.info("Twisted the {} knob {} times", knobName, count);

// now
log.info("Twisted the {} knob {} times", UnsafeArg.of("knobName", knobName), SafeArg.of("count", count));

Preconditions

Guava Preconditions equivalent which produces exceptions conforming to the SafeLoggable standard.

Usage

Add dependency to gradle:

compile "com.palantir.safe-logging:preconditions"
// optional test utilities
testCompile "com.palantir.safe-logging:preconditions-assertj"

Annotate Preconditions error messages with named SafeArg and UnsafeArg as appropriate. For example:

// previously
import com.google.common.base.Preconditions;
...
Preconditions.checkArgument(uname.size() > MAX_LEN, "%s username longer than max %s", uname, MAX_LEN);

// now
import com.palantir.logsafe.Preconditions;
...
Preconditions.checkArgument(uname.size() > MAX_LEN, "username longer than max",
        UnsafeArg.of("uname", uname), SafeArg.of("max", MAX_LEN));