{"id":8112,"date":"2024-10-13T13:30:02","date_gmt":"2024-10-13T17:30:02","guid":{"rendered":"https:\/\/springframework.guru\/?p=8112"},"modified":"2024-10-20T08:11:36","modified_gmt":"2024-10-20T12:11:36","slug":"json-logging-with-spring-boot","status":"publish","type":"post","link":"https:\/\/springframework.guru\/json-logging-with-spring-boot\/","title":{"rendered":"JSON Logging with Spring Boot Made Easy"},"content":{"rendered":"\n

JSON Logging is easy to setup with Spring Boot. Frequently, Spring Boot applications are deployed in distributed environments such as Kubernetes. In these deployments, you will likely be setting up consolidated logging.<\/p>\n\n\n\n

With consolidated logging, the log output of many applications is consolidated into a single source. To be useful, the consolidated logs need to be searchable. To aid in searching, often the logs are formatted to JSON.<\/p>\n\n\n\n

There are several options to use, one of them is Logstash. Logstash is widely accepted and is easy to configure with Spring Boot. Below, I’ll show you how easy this is to setup with Spring Boot.<\/p>\n\n\n\n

The examples used in this post are available here <\/a>on GitHub.<\/p>\n\n\n\n

JSON Logging Project Dependencies<\/h2>\n\n\n\n

First we need to add the required dependencies to our project. <\/p>\n\n\n\n

Maven<\/h4>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
<<\/span>dependency<\/span>><\/span><\/span>\n    <<\/span>groupId<\/span>>net.logstash.logback<\/<\/span>groupId<\/span>><\/span><\/span>\n    <<\/span>artifactId<\/span>>logstash-logback-encoder<\/<\/span>artifactId<\/span>><\/span><\/span>\n    <<\/span>version<\/span>>8.0<\/<\/span>version<\/span>><\/span><\/span>\n<\/<\/span>dependency<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Gradle<\/h4>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
implementation <\/span>group<\/span>: <\/span>'net.logstash.logback'<\/span>, <\/span>name<\/span>: <\/span>'logstash-logback-encoder'<\/span>, <\/span>version<\/span>: <\/span>'8.0'<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Logback Configuration for JSON Logging<\/h2>\n\n\n\n
Spring Boot uses Logback for its logging configuration. To configure Logback to support JSON logging, add the following file to your resources directory. By default, Spring Boot will look for a configuration file called logback-spring.xml<\/code> for the logback configuration.<\/p>\n\n\n\n
logback-spring.xml<\/h2>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
<<\/span>configuration<\/span>><\/span><\/span>\n<\/span>\n   <<\/span>include<\/span> <\/span>resource<\/span>=<\/span>"org\/springframework\/boot\/logging\/logback\/defaults.xml"<\/span>\/><\/span><\/span>\n   <<\/span>include<\/span> <\/span>resource<\/span>=<\/span>"org\/springframework\/boot\/logging\/logback\/console-appender.xml"<\/span> \/><\/span><\/span>\n<\/span>\n   <<\/span>springProperty<\/span> <\/span>scope<\/span>=<\/span>"context"<\/span> <\/span>name<\/span>=<\/span>"appName"<\/span> <\/span>source<\/span>=<\/span>"spring.application.name"<\/span>\/><\/span><\/span>\n<\/span>\n   <<\/span>springProfile<\/span> <\/span>name<\/span>=<\/span>"!json-logs"<\/span>><\/span><\/span>\n      <<\/span>include<\/span> <\/span>resource<\/span>=<\/span>"org\/springframework\/boot\/logging\/logback\/base.xml"<\/span> \/><\/span><\/span>\n   <\/<\/span>springProfile<\/span>><\/span><\/span>\n<\/span>\n   <<\/span>springProfile<\/span> <\/span>name<\/span>=<\/span>"json-logs"<\/span>><\/span><\/span>\n         <<\/span>appender<\/span> <\/span>name<\/span>=<\/span>"jsonConsoleAppender"<\/span> <\/span>class<\/span>=<\/span>"ch.qos.logback.core.ConsoleAppender"<\/span>><\/span><\/span>\n            <<\/span>encoder<\/span> <\/span>class<\/span>=<\/span>"net.logstash.logback.encoder.LogstashEncoder"<\/span> \/><\/span><\/span>\n          <\/<\/span>appender<\/span>><\/span><\/span>\n          <\/span><\/span>\n          <<\/span>format<\/span>><\/span><\/span>\n             <<\/span>label<\/span>><\/span><\/span>\n               <<\/span>pattern<\/span>>app=${appName},host=${HOSTNAME},traceID=%X{traceId:-NONE},level=%level<\/<\/span>pattern<\/span>><\/span><\/span>\n           <\/<\/span>label<\/span>><\/span><\/span>\n            <<\/span>message<\/span>><\/span><\/span>\n                <<\/span>pattern<\/span>>${FILE_LOG_PATTERN}<\/<\/span>pattern<\/span>><\/span><\/span>\n            <\/<\/span>message<\/span>><\/span><\/span>\n            <<\/span>sortByTime<\/span>>true<\/<\/span>sortByTime<\/span>><\/span><\/span>\n        <\/<\/span>format<\/span>><\/span><\/span>\n        <\/span><\/span>\n        <<\/span>root<\/span> <\/span>level<\/span>=<\/span>"INFO"<\/span>><\/span><\/span>\n            <<\/span>appender-ref<\/span> <\/span>ref<\/span>=<\/span>"jsonConsoleAppender"<\/span> \/><\/span><\/span>\n        <\/<\/span>root<\/span>><\/span><\/span>\n   <\/<\/span>springProfile<\/span>><\/span><\/span>\n<\/<\/span>configuration<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
This configuration does the following:<\/p>\n\n\n\n