Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Allow CommandBox to customize console appender Layout

Description

Currently, Runwar supports changing the Log pattern via the PatternLayout object. It would be handy to have a runwar argument to change the layout entirely ( e.g. the JSON Template layout https://logging.apache.org/log4j/2.x/manual/json-template-layout.html# ) in order to ship logs more efficently to other sources, such as Elastic APM

New server.json options have been added

{ "runwar":{ "console":{ "appenderLayout":"PatternLayout", "appenderLayoutOptions":{ "pattern":"%m%n" } } } }

The runwar.console.appenderLayout setting can be the name of any valid Log4j layout

https://logging.apache.org/log4j/2.x/manual/layouts.html

ex:

  • HTMLLayout

  • JSONTemplateLayout

  • XMLLayout

  • CsvLogEventLayout

  • Rfc5424Layout

  • etc

NOTE, some layouts such as CSV or XML may require additional jars not included by default in Runwar. Specify these jars in the app.libDirs setting and they will be class loaded and available to Log4j to use. The layout names are not case sensitive.

The runwar.console.appenderLayoutOptions setting is an object that provides key/value pairs that correspond with settings for the given layout. The available settings are in Log4j’s docs, linked above.

Activity

Show:

Brad WoodFebruary 6, 2023 at 11:25 PM

OK, cool. I’ll start with a way to toggle on JSON and keep my eye out for a generic approach to provide template configuration.

Jon ClausenJanuary 29, 2023 at 12:01 AM

I totally get that. The use case is looking for a way to ship logs to Elastic APM in the native format ( https://www.elastic.co/guide/en/ecs/current/ecs-reference.html ). The Java agent for APM has a very limited ability to detect log patterns and doesn’t support multi line.

I could see other use cases, though logging in JSON is becoming more popular. I would be happy with just a switch to JSON, though.

Brad WoodJanuary 28, 2023 at 11:52 PM

Ah yes, I see now. Looks like there are quite a few different layouts, each with dozens of layout-specific settings.

https://logging.apache.org/log4j/2.x/manual/layouts.html

Are you wanting to find some generic way to support all possible layouts and settings, or are you really just looking for a switch to enable the default JSON layout and call that good? I generally like a more generic approach, but I’m afraid of a setting explosion to try and support everything.

Jon ClausenJanuary 28, 2023 at 11:34 PM

No, not quite the same. The existing implementation uses the PatternLayout object. I’m interested in a mechanism to change the layout object used.

Brad WoodJanuary 28, 2023 at 10:30 PM

Fixed
Pinned fields
Click on the next to a field label to start pinning.

Details

Assignee

Reporter

Fix versions

Priority

Sentry

Created January 28, 2023 at 7:04 PM
Updated March 2, 2023 at 8:00 PM
Resolved March 2, 2023 at 8:00 PM

Flag notifications