Add support for configuring logging via JMX

Author: vpavic

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/logback/LogbackLoggingSystem.java

@@ -16,15 +16,22 @@
 
 package org.springframework.boot.logging.logback;
 
+import java.io.FileNotFoundException;
+import java.lang.management.ManagementFactory;
 import java.net.URL;
 import java.security.CodeSource;
 import java.security.ProtectionDomain;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Set;
 
+import javax.management.MBeanServer;
+import javax.management.ObjectName;
+
 import ch.qos.logback.classic.Level;
 import ch.qos.logback.classic.LoggerContext;
+import ch.qos.logback.classic.jmx.JMXConfigurator;
+import ch.qos.logback.classic.jmx.MBeanUtil;
 import ch.qos.logback.classic.joran.JoranConfigurator;
 import ch.qos.logback.classic.jul.LevelChangePropagator;
 import ch.qos.logback.classic.turbo.TurboFilter;
@@ -54,6 +61,7 @@
  * @author Dave Syer
  * @author Andy Wilkinson
  * @author Ben Hale
+ * @author Vedran Pavic
  */
 public class LogbackLoggingSystem extends Slf4JLoggingSystem {
 
@@ -124,6 +132,7 @@ protected void loadDefaults(LoggingInitializationContext initializationContext,
 			LogFile logFile) {
 		LoggerContext context = getLoggerContext();
 		stopAndReset(context);
+		registerJmxConfigurator(context, initializationContext, null, logFile);
 		LogbackConfigurator configurator = new LogbackConfigurator(context);
 		context.putProperty("LOG_LEVEL_PATTERN",
 				initializationContext.getEnvironment().resolvePlaceholders(
@@ -139,6 +148,7 @@ protected void loadConfiguration(LoggingInitializationContext initializationCont
 		super.loadConfiguration(initializationContext, location, logFile);
 		LoggerContext loggerContext = getLoggerContext();
 		stopAndReset(loggerContext);
+		registerJmxConfigurator(loggerContext, initializationContext, location, logFile);
 		try {
 			configureByResourceUrl(initializationContext, loggerContext,
 					ResourceUtils.getURL(location));
@@ -190,6 +200,28 @@ private void addLevelChangePropagator(LoggerContext loggerContext) {
 		loggerContext.addListener(levelChangePropagator);
 	}
 
+	private void registerJmxConfigurator(LoggerContext loggerContext,
+			LoggingInitializationContext initializationContext, String configLocation,
+			LogFile logFile) {
+		String objectNameAsStr = MBeanUtil.getObjectNameFor(
+				loggerContext.getName(), JMXConfigurator.class);
+		ObjectName objectName = MBeanUtil.string2ObjectName(
+				loggerContext, this, objectNameAsStr);
+		MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
+		if (!MBeanUtil.isRegistered(mbs, objectName)) {
+			LoggingSystemJMXConfigurator jmxConfigurator =
+					new LoggingSystemJMXConfigurator(loggerContext, mbs, objectName,
+							initializationContext, configLocation, logFile);
+			try {
+				mbs.registerMBean(jmxConfigurator, objectName);
+			}
+			catch (Exception e) {
+				getLogger(LogbackLoggingSystem.class.getName()).error(
+						"Failed to create mbean", e);
+			}
+		}
+	}
+
 	@Override
 	public void cleanUp() {
 		LoggerContext context = getLoggerContext();
@@ -311,4 +343,34 @@ public void run() {
 
 	}
 
+	private class LoggingSystemJMXConfigurator extends JMXConfigurator {
+
+		private LoggingInitializationContext initializationContext;
+
+		private String configLocation;
+
+		private LogFile logFile;
+
+		LoggingSystemJMXConfigurator(LoggerContext loggerContext, MBeanServer mbs,
+				ObjectName objectName, LoggingInitializationContext initializationContext,
+				String configLocation, LogFile logFile) {
+			super(loggerContext, mbs, objectName);
+			this.initializationContext = initializationContext;
+			this.configLocation = configLocation;
+			this.logFile = logFile;
+		}
+
+		@Override
+		public void reloadDefaultConfiguration() throws JoranException {
+			initialize(this.initializationContext, this.configLocation, this.logFile);
+		}
+
+		@Override
+		public void reloadByFileName(String fileName)
+				throws JoranException, FileNotFoundException {
+			initialize(this.initializationContext, fileName, this.logFile);
+		}
+
+	}
+
 }

spring-boot-project/spring-boot/src/test/java/org/springframework/boot/logging/logback/LogbackLoggingSystemTests.java

@@ -18,11 +18,14 @@
 
 import java.io.File;
 import java.io.FileReader;
+import java.lang.management.ManagementFactory;
 import java.util.EnumSet;
 import java.util.List;
 import java.util.logging.Handler;
 import java.util.logging.LogManager;
 
+import javax.management.ObjectName;
+
 import ch.qos.logback.classic.Level;
 import ch.qos.logback.classic.Logger;
 import ch.qos.logback.classic.LoggerContext;
@@ -66,6 +69,7 @@
  * @author Andy Wilkinson
  * @author Ben Hale
  * @author Madhura Bhave
+ * @author Vedran Pavic
  */
 public class LogbackLoggingSystemTests extends AbstractLoggingSystemTests {
 
@@ -129,6 +133,8 @@ public void testBasicConfigLocation() throws Exception {
 		LoggerContext context = (LoggerContext) factory;
 		Logger root = context.getLogger(org.slf4j.Logger.ROOT_LOGGER_NAME);
 		assertThat(root.getAppender("CONSOLE")).isNotNull();
+		assertThat(ManagementFactory.getPlatformMBeanServer().queryMBeans(
+				new ObjectName("ch.qos.logback.classic:Name=default,*"), null)).hasSize(1);
 	}
 
 	@Test