Add logging style via properties (#78)

skjolber · web-flow · commit c42abfd070bd · 2025-01-31T16:58:12.000+01:00
* Add logging style via properties

* Fix javax vs jakarta dependencies

* Format

* Update guides

* Adjust docs
diff --git a/azure/spring-boot-autoconfigure-azure-test/build.gradle b/azure/spring-boot-autoconfigure-azure-test/build.gradle
@@ -10,6 +10,8 @@ dependencies {
     api ("org.codehaus.janino:commons-compiler:${janinoVersion}")
     api ("org.codehaus.janino:janino:${janinoVersion}")
 
+    api("jakarta.annotation:jakarta.annotation-api:${annotationApiVersion}")
+
     api("org.springframework.boot:spring-boot-starter-logging:${springBootVersion}")
     api("org.springframework.boot:spring-boot-autoconfigure:${springBootVersion}")
 
diff --git a/azure/spring-boot-autoconfigure-azure-test/src/main/java/no/entur/logging/cloud/azure/spring/test/LoggingStyleAutoConfiguration.java b/azure/spring-boot-autoconfigure-azure-test/src/main/java/no/entur/logging/cloud/azure/spring/test/LoggingStyleAutoConfiguration.java
@@ -0,0 +1,23 @@
+package no.entur.logging.cloud.azure.spring.test;
+
+import jakarta.annotation.PostConstruct;
+import no.entur.logging.cloud.logback.logstash.test.CompositeConsoleOutputControl;
+import no.entur.logging.cloud.logback.logstash.test.CompositeConsoleOutputType;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.autoconfigure.AutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@AutoConfiguration
+@ConditionalOnProperty(name = {"entur.logging.style"})
+public class LoggingStyleAutoConfiguration {
+
+    @Value("${entur.logging.style}") CompositeConsoleOutputType style;
+
+    @PostConstruct
+    public void enforceStyle() {
+        CompositeConsoleOutputControl.setOutput(style);
+    }
+
+}
diff --git a/azure/spring-boot-autoconfigure-azure-test/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/azure/spring-boot-autoconfigure-azure-test/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
@@ -0,0 +1 @@
+no.entur.logging.cloud.azure.spring.test.LoggingStyleAutoConfiguration
diff --git a/build.gradle b/build.gradle
@@ -66,6 +66,7 @@ configure(jvmProjects()) {
         logbackLogstashSyntaxHighlightingDecoratorsVersion = '1.1.0'
         commonsIoVersion = '2.18.0'
         commonsTextVersion = '1.12.0'
+        annotationApiVersion = '2.1.1'
 
         grpcNettyVersion = '1.68.1'
         grpcVersion = '1.68.1'
diff --git a/examples/azure-grpc-ecosystem-example/build.gradle b/examples/azure-grpc-ecosystem-example/build.gradle
@@ -26,6 +26,7 @@ dependencies {
     implementation("io.grpc:grpc-netty:$grpcVersion")
     implementation("io.grpc:grpc-util:$grpcVersion")
     implementation("org.springframework.boot:spring-boot-starter:${springBootVersion}")
+    implementation("javax.annotation:javax.annotation-api:1.3.2")
 
     testImplementation project(":azure:spring-boot-starter-azure-grpc-ecosystem-test")
     testImplementation project(':azure:request-response-spring-boot-starter-azure-grpc-ecosystem-test')
diff --git a/examples/azure-web-example/src/test/java/org/entur/example/web/WebLoggingFormatViaPropertyTest.java b/examples/azure-web-example/src/test/java/org/entur/example/web/WebLoggingFormatViaPropertyTest.java
@@ -0,0 +1,39 @@
+package org.entur.example.web;
+
+import org.entur.example.web.rest.MyEntity;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
+import org.springframework.boot.test.web.client.TestRestTemplate;
+import org.springframework.boot.test.web.server.LocalServerPort;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.test.context.TestPropertySource;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
+@TestPropertySource(properties = {
+		"entur.logging.style=HumanReadableJson",
+})
+public class WebLoggingFormatViaPropertyTest {
+
+	@LocalServerPort
+	private int randomServerPort;
+	
+	@Autowired
+	private TestRestTemplate restTemplate;
+
+	@Test 
+	public void useHumanReadableJsonEncoderTest() throws InterruptedException {
+		MyEntity entity = new MyEntity();
+		entity.setName("Entur");
+		entity.setSecret("mySecret");
+
+		ResponseEntity<MyEntity> response = restTemplate.postForEntity("/api/document/some/method", entity, MyEntity.class);
+		assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK);
+	}
+
+
+}
diff --git a/examples/gcp-grpc-ecosystem-example/build.gradle b/examples/gcp-grpc-ecosystem-example/build.gradle
@@ -27,6 +27,8 @@ dependencies {
     implementation("io.grpc:grpc-util:$grpcVersion")
     implementation("org.springframework.boot:spring-boot-starter:${springBootVersion}")
 
+    implementation("javax.annotation:javax.annotation-api:1.3.2")
+
     testImplementation project(":gcp:spring-boot-starter-gcp-grpc-ecosystem-test")
     testImplementation project(':gcp:request-response-spring-boot-starter-gcp-grpc-ecosystem-test')
     testImplementation("org.springframework.boot:spring-boot-starter-test:${springBootVersion}")
diff --git a/examples/gcp-grpc-ecosystem-without-test-artifacts-example/build.gradle b/examples/gcp-grpc-ecosystem-without-test-artifacts-example/build.gradle
@@ -27,6 +27,7 @@ dependencies {
     implementation("io.grpc:grpc-netty:$grpcVersion")
     implementation("io.grpc:grpc-util:$grpcVersion")
     implementation("org.springframework.boot:spring-boot-starter:${springBootVersion}")
+    implementation("javax.annotation:javax.annotation-api:1.3.2")
 
     testImplementation("org.springframework.boot:spring-boot-starter-test:${springBootVersion}")
 
diff --git a/examples/gcp-grpc-lognet-example/build.gradle b/examples/gcp-grpc-lognet-example/build.gradle
@@ -26,6 +26,7 @@ dependencies {
     implementation("io.grpc:grpc-netty:$grpcVersion")
     implementation("io.grpc:grpc-util:$grpcVersion")
     implementation("org.springframework.boot:spring-boot-starter:${springBootVersion}")
+    implementation("javax.annotation:javax.annotation-api:1.3.2")
 
     testImplementation project(":gcp:spring-boot-starter-gcp-grpc-lognet-test")
     testImplementation project(':gcp:request-response-spring-boot-starter-gcp-grpc-lognet-test')
diff --git a/examples/gcp-grpc-lognet-without-test-artifacts-example/build.gradle b/examples/gcp-grpc-lognet-without-test-artifacts-example/build.gradle
@@ -27,6 +27,7 @@ dependencies {
     implementation("io.grpc:grpc-netty:$grpcVersion")
     implementation("io.grpc:grpc-util:$grpcVersion")
     implementation("org.springframework.boot:spring-boot-starter:${springBootVersion}")
+    implementation("javax.annotation:javax.annotation-api:1.3.2")
 
     testImplementation("org.springframework.boot:spring-boot-starter-test:${springBootVersion}")
 
diff --git a/examples/gcp-web-example/src/test/java/org/entur/example/web/WebLoggingFormatViaPropertyTest.java b/examples/gcp-web-example/src/test/java/org/entur/example/web/WebLoggingFormatViaPropertyTest.java
@@ -0,0 +1,40 @@
+package org.entur.example.web;
+
+import org.entur.example.web.rest.MyEntity;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
+import org.springframework.boot.test.web.client.TestRestTemplate;
+import org.springframework.boot.test.web.server.LocalServerPort;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.TestPropertySource;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
+@TestPropertySource(properties = {
+		"entur.logging.style=HumanReadableJson",
+})
+public class WebLoggingFormatViaPropertyTest {
+
+	@LocalServerPort
+	private int randomServerPort;
+	
+	@Autowired
+	private TestRestTemplate restTemplate;
+
+	@Test 
+	public void useHumanReadableJsonEncoderTest() throws InterruptedException {
+		MyEntity entity = new MyEntity();
+		entity.setName("Entur");
+		entity.setSecret("mySecret");
+
+		ResponseEntity<MyEntity> response = restTemplate.postForEntity("/api/document/some/method", entity, MyEntity.class);
+		assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK);
+	}
+
+
+}
diff --git a/gcp/spring-boot-autoconfigure-gcp-test/build.gradle b/gcp/spring-boot-autoconfigure-gcp-test/build.gradle
@@ -10,6 +10,8 @@ dependencies {
     api ("org.codehaus.janino:commons-compiler:${janinoVersion}")
     api ("org.codehaus.janino:janino:${janinoVersion}")
 
+    api("jakarta.annotation:jakarta.annotation-api:${annotationApiVersion}")
+
     api("org.springframework.boot:spring-boot-starter-logging:${springBootVersion}")
     api("org.springframework.boot:spring-boot-autoconfigure:${springBootVersion}")
 
diff --git a/gcp/spring-boot-autoconfigure-gcp-test/src/main/java/no/entur/logging/cloud/gcp/spring/test/LoggingStyleAutoConfiguration.java b/gcp/spring-boot-autoconfigure-gcp-test/src/main/java/no/entur/logging/cloud/gcp/spring/test/LoggingStyleAutoConfiguration.java
@@ -0,0 +1,23 @@
+package no.entur.logging.cloud.gcp.spring.test;
+
+import jakarta.annotation.PostConstruct;
+import no.entur.logging.cloud.logback.logstash.test.CompositeConsoleOutputControl;
+import no.entur.logging.cloud.logback.logstash.test.CompositeConsoleOutputType;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.autoconfigure.AutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@AutoConfiguration
+@ConditionalOnProperty(name = {"entur.logging.style"})
+public class LoggingStyleAutoConfiguration {
+
+    @Value("${entur.logging.style}") CompositeConsoleOutputType style;
+
+    @PostConstruct
+    public void enforceStyle() {
+        CompositeConsoleOutputControl.setOutput(style);
+    }
+
+}
diff --git a/gcp/spring-boot-autoconfigure-gcp-test/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/gcp/spring-boot-autoconfigure-gcp-test/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
@@ -0,0 +1 @@
+no.entur.logging.cloud.gcp.spring.test.LoggingStyleAutoConfiguration
diff --git a/guides/gRPC.md b/guides/gRPC.md
@@ -178,6 +178,7 @@ This feature adjusts the log level for individual web server requests, taking in
 * reduce log level (i.e. INFO) for
     * unexpected HTTP response codes
     * unexpected log statement levels (i.e. ERROR)
+    * unexpectedly long call duration
     * troubleshooting
 
 Import the on-demand Spring Boot starters:
@@ -224,11 +225,6 @@ For 'classic' one-line log output when running a server locally, additionally ad
   <summary>Gradle bootRun example</summary>
 
 ```groovy
-dependencies {
-   // Setup HumanReadableJsonApplicationListener without reflection
-   compileOnly("no.entur.logging.cloud:test-logback") { transitive = false }
-}
-
 tasks.register("logPlainly") {
    dependencies {
       implementation("no.entur.logging.cloud:request-response-spring-boot-starter-gcp-grpc-ecosystem-test")
@@ -240,21 +236,13 @@ tasks.withType(JavaExec).configureEach {
    dependsOn("logPlainly")
 }
 ```
-</details>
 
-Add an event listener to set your preferred log output:
+Then configure desired output by specifying `entur.logging.style`
 
 ```
-@Component
-@ConditionalOnClass(name = {"no.entur.logging.cloud.logback.logstash.test.CompositeConsoleOutputControl"})
-public class HumanReadableJsonApplicationListener implements ApplicationListener<ContextRefreshedEvent> {
-
-    @Override
-    public void onApplicationEvent(ContextRefreshedEvent event) {
-        CompositeConsoleOutputControl.useHumanReadableJsonEncoder();
-    }
-}
+entur.logging.style=humanReadablePlain|humanReadableJson|machineReadableJson
 ```
+</details>
 
 ## Opting out
 Some included features can be removed by excluding the corresponding artifacts:
@@ -277,31 +265,26 @@ For 'classic' one-line log output when running a server locally, additionally ad
   <summary>Gradle bootRun example</summary>
 
 ```groovy
-bootRun {
-    dependencies {
-        implementation("no.entur.logging.cloud:spring-boot-starter-gcp-web-test")
-        implementation("no.entur.logging.cloud:request-response-spring-boot-starter-gcp-web-test")
-    }
+tasks.register("logPlainly") {
+   dependencies {
+      implementation("no.entur.logging.cloud:request-response-spring-boot-starter-gcp-web-test")
+      implementation("no.entur.logging.cloud:spring-boot-starter-gcp-web-test")
+   }
 }
-```
 
-</details>
+tasks.withType(JavaExec).configureEach {
+   dependsOn("logPlainly")
+}
+```
 
-## Toggle output mode using profiles
-Add an event listener to set your preferred log output:
+Then configure desired output by specifying `entur.logging.style`
 
 ```
-@Component
-@Profile("local")
-public class HumanReadableJsonApplicationListener implements ApplicationListener<ContextRefreshedEvent> {
-
-    @Override
-    public void onApplicationEvent(ContextRefreshedEvent event) {
-        CompositeConsoleOutputControl.useHumanReadableJsonEncoder();
-    }
-}
+entur.logging.style=humanReadablePlain|humanReadableJson|machineReadableJson
 ```
 
+</details>
+
 ## Troubleshooting
 
 ### request-response logging not working
diff --git a/guides/web.md b/guides/web.md
@@ -168,6 +168,7 @@ This feature adjusts the log level for individual web server requests, taking in
  * reduce log level (i.e. INFO) for
    * unexpected HTTP response codes
    * unexpected log statement levels (i.e. ERROR)
+   * unexpectedly long call duration
    * troubleshooting
 
 Import the on-demand Spring Boot starters:
@@ -279,11 +280,6 @@ For 'classic' one-line log output when running a server locally, additionally ad
   <summary>Gradle bootRun example</summary>
 
 ```groovy
-dependencies {
-   // Setup HumanReadableJsonApplicationListener without reflection
-   compileOnly("no.entur.logging.cloud:test-logback") { transitive = false }
-}
-
 tasks.register("logPlainly") {
    dependencies {
       implementation("no.entur.logging.cloud:request-response-spring-boot-starter-gcp-web-test")
@@ -296,22 +292,15 @@ tasks.withType(JavaExec).configureEach {
 }
 ```
 
-</details>
-
-Add an event listener to set your preferred log output:
+Then configure desired output by specifying `entur.logging.style`
 
 ```
-@Component
-@ConditionalOnClass(name = {"no.entur.logging.cloud.logback.logstash.test.CompositeConsoleOutputControl"})
-public class HumanReadableJsonApplicationListener implements ApplicationListener<ContextRefreshedEvent> {
-
-    @Override
-    public void onApplicationEvent(ContextRefreshedEvent event) {
-        CompositeConsoleOutputControl.useHumanReadableJsonEncoder();
-    }
-}
+entur.logging.style=humanReadablePlain|humanReadableJson|machineReadableJson
 ```
 
+</details>
+
+
 ## Troubleshooting
 
 ### request-response logging not working
diff --git a/request-response/netty-grpc/build.gradle b/request-response/netty-grpc/build.gradle
@@ -41,10 +41,12 @@ dependencies {
         }
     }
 
-    api("javax.annotation:javax.annotation-api:1.3.2")
+
+    api("jakarta.annotation:jakarta.annotation-api:${annotationApiVersion}")
     api("com.google.api.grpc:proto-google-common-protos:$grpcCommonsVersion")
     api("com.google.protobuf:protobuf-java-util:${grpcProtobufVersion}")
 
+    testImplementation("javax.annotation:javax.annotation-api:1.3.2")
     testImplementation("com.google.truth:truth:${googleTruthVersion}")
     testImplementation("com.google.truth.extensions:truth-java8-extension:${googleTruthVersion}")
 }
diff --git a/trace/mdc-context-grpc-netty/build.gradle b/trace/mdc-context-grpc-netty/build.gradle
@@ -44,13 +44,14 @@ dependencies {
         }
     }
 
-    api("javax.annotation:javax.annotation-api:1.3.2")
+    api("jakarta.annotation:jakarta.annotation-api:${annotationApiVersion}")
     api("com.google.api.grpc:proto-google-common-protos:$grpcCommonsVersion")
     api("com.google.protobuf:protobuf-java-util:${grpcProtobufVersion}")
 
     testImplementation("com.google.truth:truth:${googleTruthVersion}")
     testImplementation("com.google.truth.extensions:truth-java8-extension:${googleTruthVersion}")
 
+    testImplementation("javax.annotation:javax.annotation-api:1.3.2")
     testImplementation project(":api")
     testImplementation project(":test:test-logback")
     testImplementation project(":test:test-logback-junit")
diff --git a/trace/server/correlation-id-trace-grpc-netty/build.gradle b/trace/server/correlation-id-trace-grpc-netty/build.gradle
@@ -44,10 +44,11 @@ dependencies {
         }
     }
 
-    api("javax.annotation:javax.annotation-api:1.3.2")
+    api("jakarta.annotation:jakarta.annotation-api:${annotationApiVersion}")
     api("com.google.api.grpc:proto-google-common-protos:$grpcCommonsVersion")
     api("com.google.protobuf:protobuf-java-util:${grpcProtobufVersion}")
 
+    testImplementation("javax.annotation:javax.annotation-api:1.3.2")
     testImplementation("com.google.truth:truth:${googleTruthVersion}")
     testImplementation("com.google.truth.extensions:truth-java8-extension:${googleTruthVersion}")
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+no.entur.logging.cloud.azure.spring.test.LoggingStyleAutoConfiguration`