Add JSON logging instructions [MC-2844] (#327)

* Add JSON logging instructions [MC-2844] * add a note about json templates * Update docs/modules/deploy-manage/pages/logging.adoc Co-authored-by: rebekah-lawrence <[email protected]> * remove OOTB --------- Co-authored-by: rebekah-lawrence <[email protected]>
hazelcast · Jun 4, 2024 · 2d1b69d · 2d1b69d
1 parent bcfb7f1
commit 2d1b69d
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/docs/modules/deploy-manage/pages/logging.adoc b/docs/modules/deploy-manage/pages/logging.adoc
@@ -71,6 +71,19 @@ rootLogger.appenderRef.stdout.ref=STDOUT
 rootLogger.appenderRef.rolling.ref=RollingFile
 ----
 
+To enable JSON logging, you can activate `json-logging` profile by starting Management Center with the following parameter:
+----
+-Dspring.profiles.active=json-logging
+----
+By default, Management Center uses a JSON logging template compliant with link:https://www.elastic.co/guide/en/ecs/current/ecs-reference.html[Elastic Common Schema (ECS) specification].
+You can change the logging template by providing a JSON logging template file as follows:
+----
+-Dlogging.json.template=<json-file-path>
+----
+NOTE: To use a custom JSON logging template, you must activate the `json-logging` profile as described above.
+
+For more information about the JSON logging templates, see the link:https://logging.apache.org/log4j/2.x/manual/json-template-layout.html[Log4j2 JSON Layout documentation].
+
 == Audit Logging
 
 To make it easier to examine suspicious activity and troubleshoot issues, you can use audit logging to keep a record of events that happen in Management Center such as user logins.