Skip to content

AtomicJar/logfmt-encoder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

logfmt-encoder

Maven Central

A Java library that follows the logfmt format, a logging format designed to be both human-readable and machine-parseable, making it easy to understand and analyze log data.

Usage

First, register the encoder in your logback.xml:

<configuration>
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="com.atomicjar.logging.LogFmtLayout">
            </layout>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="stdout"/>
    </root>
</configuration>

In your code, use the LogFmtMarker to add key-value pairs to your log message

LogFmtMarker logFmtMarker = LogFmtMarker
            .with("event", "release")
            .and("artifact", "logfmt-encoder")
            .and("version", "1.0.0");
logger.info(logFmtMarker, "Release is produced");