From e835c761b7bed3a598b0406d717b99cdb43e8da0 Mon Sep 17 00:00:00 2001 From: Vincent HEMERY Date: Mon, 6 Jan 2025 16:17:15 +0100 Subject: [PATCH 1/2] docs: Improve log usability Extra Note about contextMap in Json log. Relates to [BPM-331](https://bonitasoft.atlassian.net/browse/BPM-331) --- modules/setup-dev-environment/pages/logging.adoc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/modules/setup-dev-environment/pages/logging.adoc b/modules/setup-dev-environment/pages/logging.adoc index b845044504..0307a53cc8 100644 --- a/modules/setup-dev-environment/pages/logging.adoc +++ b/modules/setup-dev-environment/pages/logging.adoc @@ -135,6 +135,11 @@ Each file name includes the date when the file was created. Log files: You can exploit the Mapped Diagnostic Context (MDC) information from the Bonita Runtime log to integrate it in an external Log Management System. + These instructions demonstrate how to do it with https://eclipse.dev/tracecompass/[Eclipse Trace Compass] a free and open source traces and logs manager. You can adapt these to your favorite tool of choice. +[NOTE] +==== +This demonstration uses the textual log. In case you prefer using the JSON log format, you will find all the contextual information in `"contextMap"` attribute instead. +==== + . Download, install and launch Trace Compass. . Create a new project. Import your logs file in the Traces. From 3796fe37c57e5db3a97b789783366dab1e1b54e1 Mon Sep 17 00:00:00 2001 From: Vincent HEMERY Date: Mon, 6 Jan 2025 16:24:48 +0100 Subject: [PATCH 2/2] Update modules/setup-dev-environment/pages/logging.adoc Co-authored-by: Benjamin Parisel --- modules/setup-dev-environment/pages/logging.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/setup-dev-environment/pages/logging.adoc b/modules/setup-dev-environment/pages/logging.adoc index 0307a53cc8..e35a4cf82f 100644 --- a/modules/setup-dev-environment/pages/logging.adoc +++ b/modules/setup-dev-environment/pages/logging.adoc @@ -137,7 +137,7 @@ These instructions demonstrate how to do it with https://eclipse.dev/tracecompas [NOTE] ==== -This demonstration uses the textual log. In case you prefer using the JSON log format, you will find all the contextual information in `"contextMap"` attribute instead. +This demo uses the textual log. If you prefer to use the JSON log format, you will find all the contextual information in the `"contextMap"` attribute instead. ====