Opentelemetry support

.github/workflows/deploy-manual-snapshot.yml

@@ -13,11 +13,15 @@ on:
 
 jobs:
   deploy-snapshot-gradle:
-    uses: entur/gha-maven-central/.github/workflows/gradle-publish-snapshot.yml@copilot/gradle-publish-snapshot
+    uses: entur/gha-maven-central/.github/workflows/gradle-publish.yml@v1
     secrets: inherit
     permissions:
-      contents: read
+      contents: write
+      issues: write
     with:
+      java_version: 25
       next_version: ${{ inputs.version-increment }}
       version_strategy: tag
+      snapshot: true
+      push_to_repo: false
 

azure/logback-logstash-encoder-azure/src/main/java/no/entur/logging/cloud/azure/logback/logstash/AzureLogstashEncoder.java

@@ -2,21 +2,49 @@
 
 import ch.qos.logback.classic.spi.ILoggingEvent;
 import ch.qos.logback.core.joran.spi.DefaultClass;
+import net.logstash.logback.composite.AbstractNestedJsonProvider;
+import net.logstash.logback.composite.JsonProvider;
 import net.logstash.logback.composite.JsonProviders;
 import net.logstash.logback.composite.loggingevent.LoggingEventJsonProviders;
+import net.logstash.logback.composite.loggingevent.MdcJsonProvider;
 import net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder;
 
 public class AzureLogstashEncoder extends LoggingEventCompositeJsonEncoder {
 
     @Override
     @DefaultClass(LoggingEventJsonProviders.class)
     public void setProviders(JsonProviders<ILoggingEvent> jsonProviders) {
+
+        if(AzureOpenTelemetryTraceMdcJsonProvider.isOtelAgent()) {
+            // replace MDC provider with our own which translates agent trace_id and span_id to traceId and spanId
+            // see https://docs.azure.cn/en-us/spring-apps/basic-standard/structured-app-log
+            replaceMdcProvider(jsonProviders);
+        }
+
         AzureServiceContextJsonProvider azureServiceContextJsonProvider = new AzureServiceContextJsonProvider();
         azureServiceContextJsonProvider.autodetectService();
         jsonProviders.addProvider(azureServiceContextJsonProvider);
         super.setProviders(jsonProviders);
     }
 
+    @SuppressWarnings("unchecked")
+    private boolean replaceMdcProvider(JsonProviders<ILoggingEvent> providers) {
+        for (JsonProvider<ILoggingEvent> jsonProvider : providers.getProviders()) {
+            if (jsonProvider instanceof MdcJsonProvider) {
+                providers.removeProvider(jsonProvider);
+                providers.addProvider(new AzureOpenTelemetryTraceMdcJsonProvider());
+                return true;
+            }
+            if (jsonProvider instanceof AbstractNestedJsonProvider) {
+                JsonProviders<ILoggingEvent> nested = ((AbstractNestedJsonProvider<ILoggingEvent>) jsonProvider).getProviders();
+                if (replaceMdcProvider(nested)) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+
 
 
 }

azure/logback-logstash-encoder-azure/src/main/java/no/entur/logging/cloud/azure/logback/logstash/AzureOpenTelemetryTraceMdcJsonProvider.java

@@ -0,0 +1,69 @@
+package no.entur.logging.cloud.azure.logback.logstash;
+
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import net.logstash.logback.composite.AbstractJsonProvider;
+import tools.jackson.core.JsonGenerator;
+
+import java.lang.management.ManagementFactory;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * An MDC provider that maps OpenTelemetry trace fields to the special JSON fields
+ * recognized by Azure: https://docs.azure.cn/en-us/spring-apps/basic-standard/structured-app-log
+ *
+ */
+public class AzureOpenTelemetryTraceMdcJsonProvider extends AbstractJsonProvider<ILoggingEvent> {
+
+    public static final String OPENTELEMETRY_TRACE_ID_KEY = "trace_id";
+    public static final String OPENTELEMETRY_SPAN_ID_KEY = "span_id";
+
+    public static final String AZURE_TRACE_KEY = "traceId";
+    public static final String AZURE_SPAN_ID_KEY = "spanId";
+
+    @Override
+    public void writeTo(JsonGenerator generator, ILoggingEvent event) {
+        Map<String, String> mdcProperties = event.getMDCPropertyMap();
+        if (mdcProperties == null || mdcProperties.isEmpty()) {
+            return;
+        }
+
+        // map OTel MDC keys to Azure trace fields; write all others as-is.
+        for (Map.Entry<String, String> entry : mdcProperties.entrySet()) {
+            String key = entry.getKey();
+            if (key == null) continue;
+            String value = entry.getValue();
+            if (value == null) continue;
+
+            switch (key) {
+                case OPENTELEMETRY_TRACE_ID_KEY -> generator.writeStringProperty(AZURE_TRACE_KEY, value);
+                case OPENTELEMETRY_SPAN_ID_KEY  -> generator.writeStringProperty(AZURE_SPAN_ID_KEY, value);
+                default -> generator.writeStringProperty(key, value);
+            }
+        }
+    }
+
+    public static boolean isOtelAgent() {
+        // 1. Check direct JVM command-line arguments (-javaagent)
+        List<String> jvmArgs = ManagementFactory.getRuntimeMXBean().getInputArguments();
+        for (String arg : jvmArgs) {
+            if (isOtelArgument(arg)) {
+                return true;
+            }
+        }
+
+        // 2. Backup check for environment variables that inject JVM arguments
+        String javaToolOptions = System.getenv("JAVA_TOOL_OPTIONS");
+        if (javaToolOptions != null && isOtelArgument(javaToolOptions)) {
+            return true;
+        }
+
+        return false;
+    }
+
+    private static boolean isOtelArgument(String argument) {
+        String lowerArg = argument.toLowerCase();
+        return lowerArg.contains("-javaagent:") && lowerArg.contains("opentelemetry");
+    }
+
+}

azure/logback-logstash-encoder-azure/src/test/java/no/entur/logging/cloud/azure/logback/logstash/AzureOpenTelemetryTraceMdcJsonProviderTest.java

@@ -0,0 +1,106 @@
+package no.entur.logging.cloud.azure.logback.logstash;
+
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import org.junit.jupiter.api.Test;
+import org.mockito.Mockito;
+import tools.jackson.core.JsonGenerator;
+import tools.jackson.core.json.JsonFactory;
+import tools.jackson.databind.JsonNode;
+import tools.jackson.databind.json.JsonMapper;
+
+import java.io.StringWriter;
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+import static com.google.common.truth.Truth.assertThat;
+
+public class AzureOpenTelemetryTraceMdcJsonProviderTest {
+
+    private static final JsonMapper MAPPER = JsonMapper.builder().build();
+
+    @Test
+    void writeTo_openTelemetryTraceFields_mappedToAzureFields() throws Exception {
+        Map<String, String> mdc = new LinkedHashMap<>();
+        mdc.put(AzureOpenTelemetryTraceMdcJsonProvider.OPENTELEMETRY_TRACE_ID_KEY, "06796866738c859f2f19b7cfb3214824");
+        mdc.put(AzureOpenTelemetryTraceMdcJsonProvider.OPENTELEMETRY_SPAN_ID_KEY, "000000000000004a");
+
+        JsonNode root = write(mdc);
+
+        assertThat(root.get(AzureOpenTelemetryTraceMdcJsonProvider.AZURE_TRACE_KEY).asText())
+                .isEqualTo("06796866738c859f2f19b7cfb3214824");
+        assertThat(root.get(AzureOpenTelemetryTraceMdcJsonProvider.AZURE_SPAN_ID_KEY).asText())
+                .isEqualTo("000000000000004a");
+        assertThat(root.has(AzureOpenTelemetryTraceMdcJsonProvider.OPENTELEMETRY_TRACE_ID_KEY)).isFalse();
+        assertThat(root.has(AzureOpenTelemetryTraceMdcJsonProvider.OPENTELEMETRY_SPAN_ID_KEY)).isFalse();
+    }
+
+    @Test
+    void writeTo_unrelatedMdcFields_preserved() throws Exception {
+        Map<String, String> mdc = new LinkedHashMap<>();
+        mdc.put(AzureOpenTelemetryTraceMdcJsonProvider.OPENTELEMETRY_TRACE_ID_KEY, "abc");
+        mdc.put("correlationId", "xyz123");
+        mdc.put("userId", "user42");
+
+        JsonNode root = write(mdc);
+
+        assertThat(root.get("correlationId").asText()).isEqualTo("xyz123");
+        assertThat(root.get("userId").asText()).isEqualTo("user42");
+    }
+
+    @Test
+    void writeTo_collisionBetweenOtelAndAzureKey_otelKeyMappedFirst() throws Exception {
+        // When MDC contains both the OTel key (trace_id) and the Azure target key (traceId),
+        // the OTel key is translated to traceId and appears in the output.
+        Map<String, String> mdc = new LinkedHashMap<>();
+        mdc.put(AzureOpenTelemetryTraceMdcJsonProvider.OPENTELEMETRY_TRACE_ID_KEY, "otel-trace-value");
+        mdc.put(AzureOpenTelemetryTraceMdcJsonProvider.AZURE_TRACE_KEY, "existing-azure-trace");
+
+        JsonNode root = write(mdc);
+
+        // The OTel trace_id is mapped to traceId; readTree retains the last value on duplicate keys.
+        assertThat(root.get(AzureOpenTelemetryTraceMdcJsonProvider.AZURE_TRACE_KEY)).isNotNull();
+        assertThat(root.has(AzureOpenTelemetryTraceMdcJsonProvider.OPENTELEMETRY_TRACE_ID_KEY)).isFalse();
+    }
+
+    @Test
+    void writeTo_emptyMdc_writesNothing() throws Exception {
+        JsonNode root = write(new LinkedHashMap<>());
+        assertThat(root.size()).isEqualTo(0);
+    }
+
+    @Test
+    void writeTo_nullMdc_writesNothing() throws Exception {
+        AzureOpenTelemetryTraceMdcJsonProvider provider = new AzureOpenTelemetryTraceMdcJsonProvider();
+        ILoggingEvent event = Mockito.mock(ILoggingEvent.class);
+        Mockito.when(event.getMDCPropertyMap()).thenReturn(null);
+
+        StringWriter stringWriter = new StringWriter();
+        JsonFactory factory = new JsonFactory();
+        try (JsonGenerator generator = factory.createGenerator(stringWriter)) {
+            generator.writeStartObject();
+            provider.writeTo(generator, event);
+            generator.writeEndObject();
+        }
+        JsonNode root = MAPPER.readTree(stringWriter.toString());
+        assertThat(root.size()).isEqualTo(0);
+    }
+
+    private static JsonNode write(Map<String, String> mdcMap) throws Exception {
+        return MAPPER.readTree(writeRaw(mdcMap));
+    }
+
+    private static String writeRaw(Map<String, String> mdcMap) throws Exception {
+        AzureOpenTelemetryTraceMdcJsonProvider provider = new AzureOpenTelemetryTraceMdcJsonProvider();
+        ILoggingEvent event = Mockito.mock(ILoggingEvent.class);
+        Mockito.when(event.getMDCPropertyMap()).thenReturn(mdcMap);
+
+        StringWriter stringWriter = new StringWriter();
+        JsonFactory factory = new JsonFactory();
+        try (JsonGenerator generator = factory.createGenerator(stringWriter)) {
+            generator.writeStartObject();
+            provider.writeTo(generator, event);
+            generator.writeEndObject();
+        }
+        return stringWriter.toString();
+    }
+}

azure/spring-boot-autoconfigure-azure-test/src/main/resources/logback/spring-defaults-test.xml

@@ -12,7 +12,7 @@ Default logback configuration provided for import by spring, modified to give me
     <conversionRule conversionWord="clr" class="org.springframework.boot.logging.logback.ColorConverter" />
     <conversionRule conversionWord="wEx" class="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
 
-    <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{${LOG_DATEFORMAT_PATTERN:-HH:mm:ss.SSS}}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(---){faint} %clr([%15.15t]){faint} %clr(${LOG_CORRELATION_PATTERN:-}){faint}%clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
+    <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{${LOG_DATEFORMAT_PATTERN:-HH:mm:ss.SSS}}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
     <property name="CONSOLE_LOG_CHARSET" value="${CONSOLE_LOG_CHARSET:-${file.encoding:-UTF-8}}"/>
     <property name="CONSOLE_LOG_THRESHOLD" value="${CONSOLE_LOG_THRESHOLD:-TRACE}"/>
 

build.gradle

@@ -87,7 +87,7 @@ configure(libraryProjects()) {
 }
 
 configure(jvmProjects()) {
-    apply plugin: 'com.github.ben-manes.versions'
+    apply plugin: 'io.github.ben-manes.versions'
 
     test {
         useJUnitPlatform {

examples/gcp-grpc-spring-example/src/main/java/no/entur/grpc/example/GreetingController.java

@@ -1,7 +1,6 @@
 package no.entur.grpc.example;
 
 
-import no.entur.logging.cloud.gcp.trace.spring.grpc.interceptor.OrderedTraceIdGrpcMdcContextServerInterceptor;
 import no.entur.logging.cloud.spring.rr.grpc.OrderedGrpcLoggingServerInterceptor;
 import no.entur.logging.cloud.spring.rr.grpc.RequestResponseGrpcExceptionHandlerInterceptor;
 import no.entur.logging.cloud.trace.spring.grpc.interceptor.OrderedCorrelationIdGrpcMdcContextServerInterceptor;
@@ -12,7 +11,6 @@
 @GrpcService(interceptors = {
 		// Trace
 		OrderedCorrelationIdGrpcMdcContextServerInterceptor.class, // add trace headers (correlation-id and such)
-		OrderedTraceIdGrpcMdcContextServerInterceptor.class, // add trace headers (correlation-id and such)
 
 		// logging
 		OrderedGrpcLoggingServerInterceptor.class,

examples/gcp-grpc-spring-example/src/main/java/no/entur/grpc/example/GreetingControllerWithOnDemandLogging.java

@@ -1,7 +1,6 @@
 package no.entur.grpc.example;
 
 
-import no.entur.logging.cloud.gcp.trace.spring.grpc.interceptor.OrderedTraceIdGrpcMdcContextServerInterceptor;
 import no.entur.logging.cloud.spring.ondemand.grpc.scope.GrpcLoggingScopeContextInterceptor;
 import no.entur.logging.cloud.spring.rr.grpc.OrderedGrpcLoggingServerInterceptor;
 import no.entur.logging.cloud.spring.rr.grpc.RequestResponseGrpcExceptionHandlerInterceptor;
@@ -14,7 +13,6 @@
 		GrpcLoggingScopeContextInterceptor.class,
 		// Trace
 		OrderedCorrelationIdGrpcMdcContextServerInterceptor.class, // add trace headers (correlation-id and such)
-		OrderedTraceIdGrpcMdcContextServerInterceptor.class, // add trace headers (correlation-id and such)
 
 		// logging
 		OrderedGrpcLoggingServerInterceptor.class,

examples/gcp-grpc-spring-otel-agent-example/README.md

@@ -0,0 +1,4 @@
+# gcp-grpc-spring-otel-agent-example
+Simple GRPC service example with OpenTelemetry Java agent.
+
+This emulates the deployed application (i.e. machine-readable JSON).

examples/gcp-grpc-spring-otel-agent-example/build.gradle

@@ -0,0 +1,93 @@
+plugins {
+    id 'org.springframework.boot' version '4.1.0'
+    id "com.google.protobuf" version "0.10.0"
+}
+
+configurations {
+    otelAgent
+}
+
+test {
+    useJUnitPlatform {
+        includeEngines 'junit-jupiter'
+    }
+
+    doFirst {
+        jvmArgs "-javaagent:${configurations.otelAgent.singleFile}"
+    }
+
+    systemProperty 'otel.traces.exporter', 'logging'
+    systemProperty 'otel.metrics.exporter', 'none'
+    systemProperty 'otel.logs.exporter', 'none'
+    systemProperty 'otel.service.name', 'junit5-tests'
+
+    systemProperty 'otel.instrumentation.http.server.exclude-paths', '/actuator/**'
+}
+
+dependencies {
+    otelAgent "io.opentelemetry.javaagent:opentelemetry-javaagent:2.30.0"
+
+    implementation project(':on-demand:on-demand-spring-boot-starter-grpc')
+    implementation project(':gcp:spring-boot-starter-gcp-grpc-spring')
+    implementation project(':gcp:request-response-spring-boot-starter-gcp-grpc-spring')
+    implementation project(':trace:server:correlation-id-trace-grpc-netty')
+    implementation project(':request-response:request-response-spring-boot-autoconfigure-grpc-spring')
+
+    implementation project(':trace:mdc-context-grpc-netty')
+
+    implementation("io.grpc:grpc-api:$grpcVersion")
+    implementation("io.grpc:grpc-core:$grpcVersion")
+    implementation("io.grpc:grpc-context:$grpcVersion")
+    implementation("io.grpc:grpc-stub:$grpcVersion")
+    //implementation("io.grpc:grpc-inprocess:$grpcVersion")
+    implementation("io.grpc:grpc-services:$grpcVersion")
+    implementation("io.grpc:grpc-netty:$grpcVersion")
+    implementation("io.grpc:grpc-util:$grpcVersion")
+    implementation("org.springframework.boot:spring-boot-starter")
+
+    testImplementation project(":gcp:spring-boot-starter-gcp-grpc-spring-test")
+    testImplementation project(':gcp:request-response-spring-boot-starter-gcp-grpc-spring-test')
+    testImplementation("org.springframework.boot:spring-boot-starter-test")
+
+    // added due to grpc plugin dependency resolution problem
+    testImplementation "org.junit.platform:junit-platform-launcher"
+
+    testImplementation ("com.google.truth:truth:${googleTruthVersion}")
+    testImplementation ("com.google.truth.extensions:truth-java8-extension:${googleTruthVersion}")
+
+    testImplementation project(":test:test-logback-junit")
+}
+
+sourceSets {
+    main {
+        java {
+            srcDirs '../gcp-grpc-spring-without-test-artifacts-example/src/main/java'
+        }
+        proto {
+            srcDirs '../gcp-grpc-spring-without-test-artifacts-example/src/main/proto'
+        }
+        resources {
+            srcDirs '../gcp-grpc-spring-without-test-artifacts-example/src/main/resources'
+        }
+    }
+    test.java.srcDirs += "${protobuf.generatedFilesBaseDir}/test/java"
+    test.java.srcDirs += "${protobuf.generatedFilesBaseDir}/test/grpc"
+}
+
+tasks.compileTestJava { dependsOn("generateTestProto") }
+
+protobuf {
+    protoc {
+        artifact = "com.google.protobuf:protoc:${grpcProtobufVersion}"
+    }
+    plugins {
+        grpc {
+            artifact = "io.grpc:protoc-gen-grpc-java:$grpcVersion"
+        }
+    }
+    generateProtoTasks {
+        all()*.plugins {
+            grpc {}
+        }
+    }
+}