Fix #25220 The number of Logging pump threads grows infinitely

[kaido207]

• Fixes The number of Logging pump threads grows infinitely #25220

Fix to destroy old threads through LoggingOutputStream.close() when updating contents of logging.properties.

First, fix LoggingOutputStream.close() to be called when logging.properties is updated.
When logging.properties is updated, GlassFishLogHandler.reconfigure() is called to recreate the LoggingOutputStream based on the updated contents of logging.properties.

glassfish/nucleus/glassfish-jul-extension/src/main/java/org/glassfish/main/jul/handler/GlassFishLogHandler.java

Lines 191 to 217 in c354344

	public void reconfigure(final GlassFishLogHandlerConfiguration newConfiguration) {
	trace(GlassFishLogHandler.class, () -> "reconfigure(configuration=" + newConfiguration + ")");
	lock.lock();
	try {
	// stop using output, but allow collecting records. Logging system can continue to work.
	this.status = GlassFishLogHandlerStatus.ACCEPTING;
	this.logRecordBuffer.reconfigure(newConfiguration.getBufferCapacity(), newConfiguration.getBufferTimeout());
	if (this.rotationTimerTask != null) {
	// to avoid another task from last configuration runs it's action.
	this.rotationTimerTask.cancel();
	this.rotationTimerTask = null;
	}
	// stop pump. If reconfiguration would fail, it is better to leave it down.
	// records from the buffer will be processed if the last configuration was valid.
	stopPump();
	this.configuration = newConfiguration;
	try {
	this.status = startLoggingIfPossible();
	} catch (final Exception e) {
	this.status = GlassFishLogHandlerStatus.OFF;
	throw e;
	}
	} finally {
	lock.unlock();
	}
	}

However, there is no process to stop the existing LoggingOutputStream's Pump Thread during this recreation.

Second, fix processing so that the Pump Thread is destroyed when LoggingOutputStream.close() is called.
When LoggingOutputStream.close() is called, Pump.shutdown() is called, but Pump.shutdown() cannot stop the Pump thread.

glassfish/nucleus/glassfish-jul-extension/src/main/java/org/glassfish/main/jul/handler/LoggingOutputStream.java

Lines 171 to 175 in c354344

	void shutdown() {
	this.interrupt();
	// we interrupted waiting or working thread, now we have to process remaining records.
	logAllPendingRecords();
	}

If Pump.interrupt() is called, the implementation absorbs the InterruptException inside the LogRecordBuffer class.

glassfish/nucleus/glassfish-jul-extension/src/main/java/org/glassfish/main/jul/handler/LogRecordBuffer.java

Lines 159 to 168 in c354344

	public GlassFishLogRecord pollOrWait() {
	GlassFishLogRecord logRecord = null;
	try {
	logRecord = pendingRecords.take();
	availableCapacity.release();
	} catch (InterruptedException e) {
	// do nothing
	}
	return logRecord;
	}

Therefore, the while loop of the Pump thread does not stop when Pump.shutdown() is called.
So, the fix is to add a flag and modify Pump.shutdown() to stop Thread.

[dmatej]

Hmm, seems there conflicted two ideas in the original solution:

• That STDOUT+STDERR never close
• That GlassFishLogHandler can close and can reconfigure (and disable/enable processing of STD output)

Then your fix is correct.