Skip to content

Commit a24556c

Browse files
authored
[DOCS] Add reference to ECS-reformatting configuration (#183)
1 parent 0889fd9 commit a24556c

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/setup.asciidoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ include::./tab-widgets/code.asciidoc[]
77
[[setup-step-1]]
88
=== Step 1: Configure application logging
99

10+
If you are using the Elastic APM Java agent, the easiest way to transform your logs into ECS-compatible JSON format is through the
11+
{apm-java-ref}/config-logging.html#config-log-ecs-reformatting[`log_ecs_reformatting`] configuration option.
12+
By only setting this option, the Java agent will automatically import the correct ECS-logging library and configure your logging
13+
framework to use it instead (`OVERRIDE`/`REPLACE`) or in addition to (`SHADE`) your current configuration. No other changes required!
14+
Make sure to check out other {apm-java-ref}/config-logging.html[Logging configuration options] to unlock the full potential of this option.
15+
16+
Otherwise, follow the steps below to manually apply ECS-formatting through your logging framework configuration.
1017
The following logging frameworks are supported:
1118

1219
* Logback (default for Spring Boot)

0 commit comments

Comments
 (0)