DIGICOR

How to make logs pretty in Kibana

What does it solve?​

It solves multi-line logs such as stack trace or pretty print of JSON. Multi-line logs are now logged as several records in ELK. Each line is separated record. If you apply these changes, your stack traces or pretty printed JSON will be stored as one record.

How to:

1. Add dependency to pom.xml in your app

​

<dependency>

    <groupId>net.logstash.logback</groupId>

    <artifactId>logstash-logback-encoder</artifactId>

    <version>5.2</version>

</dependency>

​

2. Add line to your application.properties

​

spring.application.name=<Your-App-Name>

​

3. Create logback-spring.xml in <your-app>/src/main/resources/

​

<?xml version="1.0" encoding="UTF-8"?>

<configuration>

    <property resource="application.properties" />

    <contextName>${spring.application.name}</contextName>

    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">

        <encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">

            <providers>

                <contextName>

                    <fieldName>app</fieldName>

                </contextName>

                <timestamp>

                    <fieldName>ts</fieldName>

                    <timeZone>UTC</timeZone>

                </timestamp>

                <loggerName>

                    <fieldName>logger</fieldName>

                </loggerName>

                <logLevel>

                    <fieldName>level</fieldName>

                </logLevel>

                <callerData>

                    <classFieldName>class</classFieldName>

                    <methodFieldName>method</methodFieldName>

                    <lineFieldName>line</lineFieldName>

                    <fileFieldName>file</fileFieldName>

                </callerData>

                <threadName>

                    <fieldName>thread</fieldName>

                </threadName>

                <mdc />

                <arguments>

                    <includeNonStructuredArguments>false</includeNonStructuredArguments>

                </arguments>

                <stackTrace>

                    <fieldName>stack</fieldName>

                </stackTrace>

                   <message>

                    <fieldName>msg</fieldName>

                </message>

            </providers>

        </encoder>

    </appender>

    <root level="INFO">

        <appender-ref ref="CONSOLE" />

    </root>

</configuration>