Add property to control export of OTLP logs

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/logging/ConditionalOnEnabledLogging.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2012-2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.actuate.autoconfigure.logging;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.context.annotation.Conditional;
+
+/**
+ * {@link Conditional @Conditional} that checks whether logging exporter is enabled. It
+ * matches if the value of the {@code management.logging.export.enabled} property is
+ * {@code true} or if it is not configured. If the {@link #value() logging exporter name}
+ * is set, the {@code management.<name>.logging.export.enabled} property can be used to
+ * control the behavior for the specific logging exporter. In that case, the
+ * exporter-specific property takes precedence over the global property.
+ *
+ * @author Moritz Halbritter
+ * @author Dmytro Nosan
+ * @since 3.4.0
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.TYPE, ElementType.METHOD })
+@Documented
+@Conditional(OnEnabledLoggingCondition.class)
+public @interface ConditionalOnEnabledLogging {
+
+	/**
+	 * Name of the logging exporter.
+	 * @return the name of the logging exporter
+	 */
+	String value() default "";
+
+}

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/logging/OnEnabledLoggingCondition.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2012-2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.actuate.autoconfigure.logging;
+
+import java.util.Map;
+
+import org.springframework.boot.autoconfigure.condition.ConditionMessage;
+import org.springframework.boot.autoconfigure.condition.ConditionOutcome;
+import org.springframework.boot.autoconfigure.condition.SpringBootCondition;
+import org.springframework.context.annotation.ConditionContext;
+import org.springframework.core.type.AnnotatedTypeMetadata;
+import org.springframework.util.StringUtils;
+
+/**
+ * {@link SpringBootCondition} to check whether logging exporter is enabled.
+ *
+ * @author Moritz Halbritter
+ * @author Dmytro Nosan
+ * @see ConditionalOnEnabledLogging
+ */
+class OnEnabledLoggingCondition extends SpringBootCondition {
+
+	private static final String GLOBAL_PROPERTY = "management.logging.export.enabled";
+
+	private static final String EXPORTER_PROPERTY = "management.%s.logging.export.enabled";
+
+	@Override
+	public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {
+		String loggingExporter = getExporterName(metadata);
+		if (StringUtils.hasLength(loggingExporter)) {
+			Boolean exporterLoggingEnabled = context.getEnvironment()
+				.getProperty(EXPORTER_PROPERTY.formatted(loggingExporter), Boolean.class);
+			if (exporterLoggingEnabled != null) {
+				return new ConditionOutcome(exporterLoggingEnabled,
+						ConditionMessage.forCondition(ConditionalOnEnabledLogging.class)
+							.because(EXPORTER_PROPERTY.formatted(loggingExporter) + " is " + exporterLoggingEnabled));
+			}
+		}
+		Boolean globalLoggingEnabled = context.getEnvironment().getProperty(GLOBAL_PROPERTY, Boolean.class);
+		if (globalLoggingEnabled != null) {
+			return new ConditionOutcome(globalLoggingEnabled,
+					ConditionMessage.forCondition(ConditionalOnEnabledLogging.class)
+						.because(GLOBAL_PROPERTY + " is " + globalLoggingEnabled));
+		}
+		return ConditionOutcome.match(ConditionMessage.forCondition(ConditionalOnEnabledLogging.class)
+			.because("logging is enabled by default"));
+	}
+
+	private static String getExporterName(AnnotatedTypeMetadata metadata) {
+		Map<String, Object> attributes = metadata.getAnnotationAttributes(ConditionalOnEnabledLogging.class.getName());
+		if (attributes == null) {
+			return null;
+		}
+		return (String) attributes.get("value");
+	}
+
+}

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/logging/otlp/OtlpLoggingAutoConfiguration.java

@@ -20,6 +20,7 @@
 import io.opentelemetry.exporter.otlp.http.logs.OtlpHttpLogRecordExporter;
 import io.opentelemetry.sdk.logs.SdkLoggerProvider;
 
+import org.springframework.boot.actuate.autoconfigure.logging.ConditionalOnEnabledLogging;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
@@ -36,6 +37,7 @@
 @ConditionalOnClass({ SdkLoggerProvider.class, OpenTelemetry.class, OtlpHttpLogRecordExporter.class })
 @EnableConfigurationProperties(OtlpLoggingProperties.class)
 @Import({ OtlpLoggingConfigurations.ConnectionDetails.class, OtlpLoggingConfigurations.Exporters.class })
+@ConditionalOnEnabledLogging("otlp")
 public class OtlpLoggingAutoConfiguration {
 
 }

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -309,6 +309,12 @@
       "description": "Whether to enable SSL certificate info.",
       "defaultValue": false
     },
+    {
+      "name": "management.logging.export.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Whether the auto-configuration for exporting log record data is enabled",
+      "defaultValue": true
+    },
     {
       "name": "management.metrics.binders.files.enabled",
       "type": "java.lang.Boolean",
@@ -2067,6 +2073,11 @@
       "description": "Whether auto-configuration of Micrometer annotations is enabled.",
       "defaultValue": false
     },
+    {
+      "name": "management.otlp.logging.export.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Whether auto-configuration for exporting OTLP log records is enabled."
+    },
     {
       "name": "management.otlp.tracing.export.enabled",
       "type": "java.lang.Boolean",

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/logging/OnEnabledLoggingConditionTests.java

@@ -0,0 +1,130 @@
+/*
+ * Copyright 2012-2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.actuate.autoconfigure.logging;
+
+import java.util.Collections;
+import java.util.Map;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.boot.autoconfigure.condition.ConditionOutcome;
+import org.springframework.context.annotation.ConditionContext;
+import org.springframework.core.type.AnnotatedTypeMetadata;
+import org.springframework.mock.env.MockEnvironment;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.BDDMockito.given;
+import static org.mockito.Mockito.mock;
+
+/**
+ * Tests for {@link OnEnabledLoggingCondition}.
+ *
+ * @author Moritz Halbritter
+ * @author Dmytro Nosan
+ */
+class OnEnabledLoggingConditionTests {
+
+	@Test
+	void shouldMatchIfNoPropertyIsSet() {
+		OnEnabledLoggingCondition condition = new OnEnabledLoggingCondition();
+		ConditionOutcome outcome = condition.getMatchOutcome(mockConditionContext(), mockMetadata(""));
+		assertThat(outcome.isMatch()).isTrue();
+		assertThat(outcome.getMessage()).isEqualTo("@ConditionalOnEnabledLogging logging is enabled by default");
+	}
+
+	@Test
+	void shouldNotMatchIfGlobalPropertyIsFalse() {
+		OnEnabledLoggingCondition condition = new OnEnabledLoggingCondition();
+		ConditionOutcome outcome = condition.getMatchOutcome(
+				mockConditionContext(Map.of("management.logging.export.enabled", "false")), mockMetadata(""));
+		assertThat(outcome.isMatch()).isFalse();
+		assertThat(outcome.getMessage())
+			.isEqualTo("@ConditionalOnEnabledLogging management.logging.export.enabled is false");
+	}
+
+	@Test
+	void shouldMatchIfGlobalPropertyIsTrue() {
+		OnEnabledLoggingCondition condition = new OnEnabledLoggingCondition();
+		ConditionOutcome outcome = condition.getMatchOutcome(
+				mockConditionContext(Map.of("management.logging.export.enabled", "true")), mockMetadata(""));
+		assertThat(outcome.isMatch()).isTrue();
+		assertThat(outcome.getMessage())
+			.isEqualTo("@ConditionalOnEnabledLogging management.logging.export.enabled is true");
+	}
+
+	@Test
+	void shouldNotMatchIfExporterPropertyIsFalse() {
+		OnEnabledLoggingCondition condition = new OnEnabledLoggingCondition();
+		ConditionOutcome outcome = condition.getMatchOutcome(
+				mockConditionContext(Map.of("management.otlp.logging.export.enabled", "false")), mockMetadata("otlp"));
+		assertThat(outcome.isMatch()).isFalse();
+		assertThat(outcome.getMessage())
+			.isEqualTo("@ConditionalOnEnabledLogging management.otlp.logging.export.enabled is false");
+	}
+
+	@Test
+	void shouldMatchIfExporterPropertyIsTrue() {
+		OnEnabledLoggingCondition condition = new OnEnabledLoggingCondition();
+		ConditionOutcome outcome = condition.getMatchOutcome(
+				mockConditionContext(Map.of("management.otlp.logging.export.enabled", "true")), mockMetadata("otlp"));
+		assertThat(outcome.isMatch()).isTrue();
+		assertThat(outcome.getMessage())
+			.isEqualTo("@ConditionalOnEnabledLogging management.otlp.logging.export.enabled is true");
+	}
+
+	@Test
+	void exporterPropertyShouldOverrideGlobalPropertyIfTrue() {
+		OnEnabledLoggingCondition condition = new OnEnabledLoggingCondition();
+		ConditionOutcome outcome = condition.getMatchOutcome(mockConditionContext(
+				Map.of("management.logging.enabled", "false", "management.otlp.logging.export.enabled", "true")),
+				mockMetadata("otlp"));
+		assertThat(outcome.isMatch()).isTrue();
+		assertThat(outcome.getMessage())
+			.isEqualTo("@ConditionalOnEnabledLogging management.otlp.logging.export.enabled is true");
+	}
+
+	@Test
+	void exporterPropertyShouldOverrideGlobalPropertyIfFalse() {
+		OnEnabledLoggingCondition condition = new OnEnabledLoggingCondition();
+		ConditionOutcome outcome = condition.getMatchOutcome(mockConditionContext(
+				Map.of("management.logging.enabled", "true", "management.otlp.logging.export.enabled", "false")),
+				mockMetadata("otlp"));
+		assertThat(outcome.isMatch()).isFalse();
+		assertThat(outcome.getMessage())
+			.isEqualTo("@ConditionalOnEnabledLogging management.otlp.logging.export.enabled is false");
+	}
+
+	private ConditionContext mockConditionContext() {
+		return mockConditionContext(Collections.emptyMap());
+	}
+
+	private ConditionContext mockConditionContext(Map<String, String> properties) {
+		ConditionContext context = mock(ConditionContext.class);
+		MockEnvironment environment = new MockEnvironment();
+		properties.forEach(environment::setProperty);
+		given(context.getEnvironment()).willReturn(environment);
+		return context;
+	}
+
+	private AnnotatedTypeMetadata mockMetadata(String exporter) {
+		AnnotatedTypeMetadata metadata = mock(AnnotatedTypeMetadata.class);
+		given(metadata.getAnnotationAttributes(ConditionalOnEnabledLogging.class.getName()))
+			.willReturn(Map.of("value", exporter));
+		return metadata;
+	}
+
+}

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/logging/otlp/OtlpLoggingAutoConfigurationTests.java

@@ -73,6 +73,14 @@ void shouldNotSupplyBeansIfDependencyIsMissing(String packageName) {
 		});
 	}
 
+	@Test
+	void shouldBackOffWhenOtlpLoggingExportPropertyIsNotEnabled() {
+		this.contextRunner.withPropertyValues("management.otlp.logging.export.enabled=false").run((context) -> {
+			assertThat(context).doesNotHaveBean(OtlpLoggingConnectionDetails.class);
+			assertThat(context).doesNotHaveBean(LogRecordExporter.class);
+		});
+	}
+
 	@Test
 	void shouldBackOffWhenCustomHttpExporterIsDefined() {
 		this.contextRunner.withUserConfiguration(CustomHttpExporterConfiguration.class)