Uploaded image for project: 'Nuxeo Platform'
  1. Nuxeo Platform
  2. NXP-32668

Make the Nuxeo Launcher Log4j configuration file overridable

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2025.x, 2023.19
    • Component/s: Launcher
    • Release Notes Summary:
      The Log4j configuration file for Nuxeo Launcher can now be customized
    • Release Notes Description:
      Hide

      Previously present in the launcher, the Nuxeo Launcher Log4j configuration file has been extracted to ${NUXEO_HOME}/lib/log4j2-launcher.xml so it could be edited.

      A new nuxeo.conf property has been introduced to reference the log4j configuration file if needed:

      launcher.log4j2.file=/etc/nuxeo/log4j2-launcher.xml

      WARNING:
      variable expansion is not supported on this property because the property is used before launcher invocation which owns this mechanism.

      Show
      Previously present in the launcher, the Nuxeo Launcher Log4j configuration file has been extracted to ${NUXEO_HOME}/lib/log4j2-launcher.xml so it could be edited. A new nuxeo.conf property has been introduced to reference the log4j configuration file if needed: launcher.log4j2.file=/etc/nuxeo/log4j2-launcher.xml WARNING: variable expansion is not supported on this property because the property is used before launcher invocation which owns this mechanism.
    • Tags:
    • Upgrade notes:
      Hide

      The bin/nuxeoctl script has been updated by this feature, so if you're using the HF mechanism on a standalone zip server, you might set back the execute permission to bin/nuxeoctl, something like below:

      chmod +x bin/nuxeoctl
      Show
      The bin/nuxeoctl script has been updated by this feature, so if you're using the HF mechanism on a standalone zip server, you might set back the execute permission to bin/nuxeoctl , something like below: chmod +x bin/nuxeoctl
    • Team:
      PLATFORM
    • Sprint:
      nxplatform #121
    • Story Points:
      3

      Description

      We want to be able to update and override the Nuxeo Launcher log4j2.xml file, for instance to configure the logs as JSON to be sent to Datadog.

      The Nuxeo Launcher log4j2.xml file must be extracted from the Launcher itself and put into the NUXEO_HOME/lib folder, like the log4j2.xml file for the Nuxeo Server. The file should be renamed to log4j2-launcher.xml.

      Final step, configure the Nuxeo Launcher to read the NUXEO_HOME/lib/log4j2-launcher.xml.

        Attachments

          Issue Links

          is related to

          Improvement - An improvement or enhancement to an existing feature or task. NXP-32875 Configure Tomcat logs with Log4j

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: