Simplify Spring Boot configuration (#65)

Author: felixbarny

README.md

@@ -94,13 +94,17 @@ We recommend using this library to log into a JSON log file and let Filebeat sen
 
 ## Getting Started
 
-### Logging configuration
+### Step 1: Configure application logging
 
-- [Logback](logback-ecs-encoder/README.md)
+- [Logback](logback-ecs-encoder/README.md) (default for Spring Boot)
 - [Log4j2](log4j2-ecs-layout/README.md)
 - [Log4j](log4j-ecs-layout/README.md)
 
-### Filebeat configuration
+### Step 2: Enable APM log correlation (optional)
+If you are using the Elastic APM Java agent,
+set [`enable_log_correlation`](https://www.elastic.co/guide/en/apm/agent/java/current/config-logging.html#config-enable-log-correlation) to `true`.
+
+### Step 3: Filebeat configuration
 
 #### With `filebeat.yml` configuration file
 

logback-ecs-encoder/README.md

@@ -15,47 +15,45 @@ Add a dependency to your application
 
 ## Step 2: use the `EcsEncoder`
 
-All you have to do is to use the `co.elastic.logging.logback.EcsEncoder` instead of the default pattern encoder
-```xml
-<encoder class="co.elastic.logging.logback.EcsEncoder">
-    <serviceName>my-application</serviceName>
-</encoder>
-```
+## Spring Boot applications
 
-## Example `logback.xml` for Spring Boot applications
- 
+`src/main/resources/logback-spring.xml`
 ```xml
 <?xml version="1.0" encoding="UTF-8"?>
 <configuration>
+    <property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/>
     <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
-    <include resource="org/springframework/boot/logging/logback/file-appender.xml"/>
-    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
-        <encoder class="co.elastic.logging.logback.EcsEncoder">
-            <serviceName>my-application</serviceName>
-        </encoder>
-    </appender>
-    <appender name="json-file" class="ch.qos.logback.core.rolling.RollingFileAppender">
-        <encoder class="co.elastic.logging.logback.EcsEncoder">
-            <serviceName>my-application</serviceName>
-        </encoder>
-        <file>${LOG_FILE}.json</file>
-        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
-            <fileNamePattern>${LOG_FILE}.json.%d{yyyy-MM-dd}.%i.gz</fileNamePattern>
-            <maxFileSize>${LOG_FILE_MAX_SIZE:-10MB}</maxFileSize>
-            <maxHistory>${LOG_FILE_MAX_HISTORY:-0}</maxHistory>
-        </rollingPolicy>
-    </appender>
-
+    <include resource="org/springframework/boot/logging/logback/console-appender.xml" />
+    <include resource="org/springframework/boot/logging/logback/file-appender.xml" />
+    <include resource="co/elastic/logging/logback/boot/ecs-file-appender.xml" />
     <root level="INFO">
-        <appender-ref ref="console"/>
-        <appender-ref ref="json-file"/>
-        <!-- uncomment this if you also want to log in plain text        
+        <appender-ref ref="CONSOLE"/>
+        <appender-ref ref="ECS_JSON_FILE"/>
         <appender-ref ref="FILE"/>
-        -->
     </root>
 </configuration>
 ```
 
+You also need to configure the following properties to your `application.properties`:
+
+```properties
+spring.application.name=my-application
+# for Spring Boot 2.2.x+
+logging.file.name=/path/to/my-application.log
+# for older Spring Boot versions
+logging.file=/path/to/my-application.log
+```
+
+## Other applications 
+
+All you have to do is to use the `co.elastic.logging.logback.EcsEncoder` instead of the default pattern encoder in `logback.xml`
+
+```xml
+<encoder class="co.elastic.logging.logback.EcsEncoder">
+    <serviceName>my-application</serviceName>
+</encoder>
+```
+
 ## Encoder Parameters
 
 |Parameter name   |Type   |Default|Description|

logback-ecs-encoder/src/main/resources/co/elastic/logging/logback/boot/ecs-file-appender.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ECS JSON file appender logback configuration provided for import, similar to the file-appender.xml included in Spring Boot
+<include resource="co/elastic/logging/logback/boot/ecs-file-appender.xml" />
+-->
+
+<included>
+    <springProperty name="SERVICE_NAME" source="spring.application.name"/>
+    <appender name="ECS_JSON_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
+        <encoder class="co.elastic.logging.logback.EcsEncoder">
+            <serviceName>${SERVICE_NAME:-spring-boot-application}</serviceName>
+        </encoder>
+        <file>${LOG_FILE}.json</file>
+        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
+            <cleanHistoryOnStart>${LOG_FILE_CLEAN_HISTORY_ON_START:-false}</cleanHistoryOnStart>
+            <fileNamePattern>${ROLLING_FILE_NAME_PATTERN:-${LOG_FILE}.json.%d{yyyy-MM-dd}.%i.gz}</fileNamePattern>
+            <maxFileSize>${LOG_FILE_MAX_SIZE:-10MB}</maxFileSize>
+            <maxHistory>${LOG_FILE_MAX_HISTORY:-7}</maxHistory>
+            <totalSizeCap>${LOG_FILE_TOTAL_SIZE_CAP:-0}</totalSizeCap>
+        </rollingPolicy>
+    </appender>
+</included>