feat(docs): describe how to enable json logging (#1772)

tchiotludo · May 21, 2024 · 515298d · 515298d
1 parent a01e779
commit 515298d
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/docs/docs/configuration/others.md b/docs/docs/configuration/others.md
@@ -13,3 +13,18 @@
 > Since AKHQ is based on [Micronaut](https://micronaut.io/), you can customize configurations (server port, ssl, ...) with [Micronaut configuration](https://docs.micronaut.io/snapshot/guide/configurationreference.html#io.micronaut.http.server.HttpServerConfiguration).
 > More information can be found on [Micronaut documentation](https://docs.micronaut.io/snapshot/guide/index.html#config)
 
+## JSON Logging
+In order to configure AKHQ to output log in JSON format, a logback configuration needs to be provided, e.g. `logback.xml`
+```
+<configuration>
+  <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
+    <encoder class="ch.qos.logback.classic.encoder.JsonEncoder">
+    </encoder>
+  </appender>
+
+  <root level="debug">
+    <appender-ref ref="stdout"/>
+  </root>
+</configuration>
+```
+This file then needs to be mounted to `/app/logback.xml` and referenced in `JAVA_OPTS` via `-Dlogback.configurationFile=/app/logback.xml` (see [docker](docker.md) for more information).