Last active
October 30, 2019 10:46
-
-
Save mikybars/cee26759a7490dafb15dfc1658ed9585 to your computer and use it in GitHub Desktop.
Maven, logback & log4j2 setup for logging JSON in Java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| package com.example.logging.converters; | |
| import ch.qos.logback.classic.pattern.ThrowableProxyConverter; | |
| import ch.qos.logback.classic.spi.IThrowableProxy; | |
| import ch.qos.logback.classic.spi.StackTraceElementProxy; | |
| public class ExceptionMessageConverter extends ThrowableProxyConverter { | |
| @Override | |
| protected String throwableProxyToString(IThrowableProxy tp) { | |
| StackTraceElementProxy[] stackTrace = tp.getStackTraceElementProxyArray(); | |
| for (StackTraceElementProxy stackLine : stackTrace) { | |
| stackLine.getStackTraceElement(). | |
| } | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| package com.example.logging.converters; | |
| import ch.qos.logback.classic.pattern.ThrowableProxyConverter; | |
| import ch.qos.logback.classic.spi.IThrowableProxy; | |
| public class ExceptionNameConverter extends ThrowableProxyConverter { | |
| @Override | |
| protected String throwableProxyToString(IThrowableProxy tp) { | |
| return tp.getClassName(); | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?xml version="1.0" encoding="UTF-8"?> | |
| <configuration status="warn" packages="org.apache.logging.log4j.core"> | |
| <appenders> | |
| <Console name="Console" target="SYSTEM_OUT"> | |
| <LogstashLayout dateTimeFormatPattern="yyyy-MM-dd'T'HH:mm:ss,SSS" | |
| prettyPrintEnabled="false" | |
| eventTemplateUri="classpath:log4j2EventLayout.json" | |
| stackTraceEnabled="true"/> | |
| </Console> | |
| </appenders> | |
| <loggers> | |
| <root level="${env:SERVICE_LOG_LEVEL:-INFO}"> | |
| <appender-ref ref="Console" /> | |
| </root> | |
| </loggers> | |
| </configuration> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "loggingBackend": "log4j", | |
| "executionTimestamp": "${json:timestamp}", | |
| "level": "${json:level}", | |
| "service": "${env:APPLICATION_NAME:-undefined}", | |
| "operationId": "${json:mdc:operationId}", | |
| "component": "${json:logger:name}", | |
| "message": "${json:message}", | |
| "exception": { | |
| "name": "${json:exception:className}", | |
| "message": "${json:exception:message}", | |
| "stacktrace": "${json:exception:stackTrace:text}" | |
| } | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <configuration> | |
| <!-- https://stackoverflow.com/a/52512131--> | |
| <conversionRule conversionWord="exname" converterClass="com.example.logging.converters.ExceptionNameConverter"/> | |
| <conversionRule conversionWord="exmessage" converterClass="com.example.logging.converters.ExceptionMessageConverter"/> | |
| <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> | |
| <encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder"> | |
| <providers> | |
| <pattern> | |
| <omitEmptyFields>true</omitEmptyFields> | |
| <pattern> | |
| { | |
| "loggingBackend": "logback", | |
| "executionTimestamp": "%date{yyyy-MM-dd'T'HH:mm:ss,SSS}", | |
| "level": "%level", | |
| "service": "${APPLICATION_NAME:-undefined}", | |
| "operationId": "%mdc{operationId}", | |
| "component": "%logger", | |
| "message": "%message", | |
| "exception": { | |
| "name": "%exname", | |
| "message": "%exmessage", | |
| "stacktrace": "%throwable" | |
| } | |
| } | |
| </pattern> | |
| </pattern> | |
| </providers> | |
| </encoder> | |
| </appender> | |
| <root level="${SERVICE_LOG_LEVEL:-INFO}"> | |
| <appender-ref ref="STDOUT"/> | |
| </root> | |
| </configuration> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <project> | |
| <dependencies> | |
| <!-- for logback --> | |
| <dependency> | |
| <groupId>net.logstash.logback</groupId> | |
| <artifactId>logstash-logback-encoder</artifactId> | |
| <version>${logback-logstash.version}</version> | |
| <scope>runtime</scope> | |
| </dependency> | |
| <!-- for log4j2 --> | |
| <dependency> | |
| <groupId>com.vlkan.log4j2</groupId> | |
| <artifactId>log4j2-logstash-layout</artifactId> | |
| <version>${log4j-logstash.version}</version> | |
| <scope>runtime</scope> | |
| </dependency> | |
| </dependencies> | |
| </project> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment