Uploaded image for project: 'Log4j 2'
  1. Log4j 2
  2. LOG4J2-2954

Shutdown callbacks registered in LoggerContext.setUpShutdownHook() aren't strongly referenced

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 2.13.3
    • Fix Version/s: 2.14.0
    • Component/s: Core
    • Labels:
      None

      Description

      LoggerContext.setUpShutdownHook() passes a callback to the DefaultShutdownCallbackRegistry. To avoid a memory leak, the registry only holds a soft reference to the passed callback.

      However, the callback is itself just an inline lambda not-otherwise-referenced. Even while the context is alive, the callback will soon become eligible for GC once the SoftReference timer-from-last-access expires. By the time the shutdown hooks actually run, the references are cleared and the context is not gracefully closed.


      Probably surfaced after https://github.com/apache/logging-log4j2/commit/bee90521bb63e6162a9cbed606adde4242675c62. Fixing that leak (which actually kept the callback alive) now makes the callback completely unreferenced (strongly).

      Suggested fix:

      • make RegisteredCancellable.hook a strong reference
      • make DefaultShutdownCallbackRegistry.hooks a Collection<WeakReference<...>>

      This would keep the callback alive as long as the returned registration object (the Cancellable) is alive, and the LoggerContext does reference that.


      Note: Unclear if the above is actually a complete solution. "LoggerContext eligible for GC" doesn't seem to imply "LoggerContext contents all flushed to disk" - the strong reference from the shutdown hook to the context actually seems necessary, to guarantee that any buffers in the context will be flushed even if the context itself happens to become unreferenced.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                ckozak Carter Kozak
                Reporter:
                henryptung Henry Tung
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: