Provide configuration property to disable console logging

Add `logging.console.enabled` which when set will cause the
`logging.threshold.console` property to be set to `OFF`.

Closes gh-46592

Author: philwebb

core/spring-boot/src/main/java/org/springframework/boot/logging/LoggingSystemProperties.java

@@ -143,6 +143,9 @@ protected void apply(@Nullable LogFile logFile, PropertyResolver resolver) {
 		if (logFile != null) {
 			logFile.applyToSystemProperties();
 		}
+		if (!this.environment.getProperty("logging.console.enabled", Boolean.class, true)) {
+			setSystemProperty(LoggingSystemProperty.CONSOLE_THRESHOLD.getEnvironmentVariableName(), "OFF");
+		}
 	}
 
 	/**

core/spring-boot/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -29,6 +29,12 @@
       "description": "Location of the logging configuration file. For instance, `classpath:logback.xml` for Logback.",
       "sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener"
     },
+    {
+      "name": "logging.console.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Whether to enable console based logging",
+      "sourceType": "org.springframework.boot.context.logging.LoggingApplicationListener"
+    },
     {
       "name": "logging.exception-conversion-word",
       "type": "java.lang.String",

core/spring-boot/src/test/java/org/springframework/boot/logging/LoggingSystemPropertiesTests.java

@@ -232,6 +232,21 @@ void shouldSetConsoleStructuredLogging() {
 			.isEqualTo("ecs");
 	}
 
+	@Test
+	void shouldSetConsoleLevelThreshholdToOffWhenConsoleLoggingDisabled() {
+		new LoggingSystemProperties(new MockEnvironment().withProperty("logging.console.enabled", "false")).apply(null);
+		assertThat(System.getProperty(LoggingSystemProperty.CONSOLE_THRESHOLD.getEnvironmentVariableName()))
+			.isEqualTo("OFF");
+	}
+
+	@Test
+	void shouldNotChangeConsoleLevelThreshholdWhenConsoleLoggingEnabled() {
+		new LoggingSystemProperties(new MockEnvironment().withProperty("logging.console.enabled", "true")
+			.withProperty("logging.threshold.console", "TRACE")).apply(null);
+		assertThat(System.getProperty(LoggingSystemProperty.CONSOLE_THRESHOLD.getEnvironmentVariableName()))
+			.isEqualTo("TRACE");
+	}
+
 	private Environment environment(String key, Object value) {
 		StandardEnvironment environment = new StandardEnvironment();
 		environment.getPropertySources().addLast(new MapPropertySource("test", Collections.singletonMap(key, value)));

documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/features/logging.adoc

@@ -71,6 +71,8 @@ Enabling the debug mode does _not_ configure your application to log all message
 Alternatively, you can enable a "`trace`" mode by starting your application with a `--trace` flag (or `trace=true` in your `application.properties`).
 Doing so enables trace logging for a selection of core loggers (embedded container, Hibernate schema generation, and the whole Spring portfolio).
 
+If you wan to disable console based logging, you can set the configprop:logging.console.enabled[] property to `false`.
+
 
 
 [[features.logging.console-output.color-coded]]

smoke-test/spring-boot-smoke-test-logback/src/test/java/smoketest/logback/SampleLogbackApplicationTests.java

@@ -39,4 +39,10 @@ void testProfile(CapturedOutput output) {
 		assertThat(output).contains("Sample Debug Message").contains("Sample Trace Message");
 	}
 
+	@Test
+	void testDisableConsoleLogging(CapturedOutput output) {
+		SampleLogbackApplication.main(new String[] { "--logging.console.enabled=false" });
+		assertThat(output).doesNotContain("---");
+	}
+
 }