Move request ID generator configuration to polaris.tracing

Author: adutra

CHANGELOG.md

@@ -53,6 +53,9 @@ request adding CHANGELOG notes for breaking (!) changes and possibly other secti
 ### Deprecations
 
 * The property `polaris.active-roles-provider.type` is deprecated and has no effect anymore.
+* The property `polaris.log.request-id-header-name` has been renamed to
+  `polaris.tracing.request-id-generator.header-name`; the old name is still supported for backwards
+  compatibility, but will generate a warning.
 
 ### Fixes
 

runtime/defaults/src/main/resources/application.properties

@@ -137,7 +137,6 @@ polaris.event-listener.type=no-op
 # polaris.event-listener.persistence-in-memory-buffer.buffer-time=5000ms
 # polaris.event-listener.persistence-in-memory-buffer.max-buffer-size=5
 
-polaris.log.request-id-header-name=Polaris-Request-Id
 # polaris.log.mdc.aid=polaris
 # polaris.log.mdc.sid=polaris-service
 
@@ -146,6 +145,9 @@ polaris.metrics.tags.application=Polaris
 # polaris.metrics.tags.environment=prod
 # polaris.metrics.tags.region=us-west-2
 
+polaris.tracing.request-id-generator.type=default
+polaris.tracing.request-id-generator.header-name=Polaris-Request-Id
+
 # polaris.tasks.max-concurrent-tasks=100
 # polaris.tasks.max-queued-tasks=1000
 

runtime/service/src/main/java/org/apache/polaris/service/config/ConfigRelocationInterceptor.java

@@ -0,0 +1,42 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *   http://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.apache.polaris.service.config;
+
+import io.smallrye.config.RelocateConfigSourceInterceptor;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class ConfigRelocationInterceptor extends RelocateConfigSourceInterceptor {
+
+  private static final Logger LOGGER = LoggerFactory.getLogger(ConfigRelocationInterceptor.class);
+
+  public ConfigRelocationInterceptor() {
+    super(ConfigRelocationInterceptor::applyRelocations);
+  }
+
+  private static String applyRelocations(String name) {
+    if (name.equals("polaris.log.request-id-header-name")) {
+      String replacement = "polaris.tracing.request-id-generator.header-name";
+      LOGGER.warn("Property '{}' is deprecated, use '{}' instead", name, replacement);
+      return replacement;
+    }
+    return name;
+  }
+}

runtime/service/src/main/java/org/apache/polaris/service/config/ServiceProducers.java

@@ -81,6 +81,8 @@
 import org.apache.polaris.service.storage.aws.S3AccessConfig;
 import org.apache.polaris.service.storage.aws.StsClientsPool;
 import org.apache.polaris.service.task.TaskHandlerConfiguration;
+import org.apache.polaris.service.tracing.RequestIdGenerator;
+import org.apache.polaris.service.tracing.TracingConfiguration;
 import org.eclipse.microprofile.context.ManagedExecutor;
 import org.eclipse.microprofile.context.ThreadContext;
 import org.slf4j.Logger;
@@ -392,6 +394,15 @@ public OidcTenantResolver oidcTenantResolver(
     return resolvers.select(Identifier.Literal.of(config.tenantResolver())).get();
   }
 
+  @Produces
+  @ApplicationScoped
+  public RequestIdGenerator requestIdGenerator(
+      TracingConfiguration config, @Any Instance<RequestIdGenerator> requestIdGenerators) {
+    return requestIdGenerators
+        .select(Identifier.Literal.of(config.requestIdGenerator().type()))
+        .get();
+  }
+
   public void closeTaskExecutor(@Disposes @Identifier("task-executor") ManagedExecutor executor) {
     executor.close();
   }

runtime/service/src/main/java/org/apache/polaris/service/logging/LoggingConfiguration.java

@@ -24,9 +24,6 @@
 @ConfigMapping(prefix = "polaris.log")
 public interface LoggingConfiguration {
 
-  /** The name of the header that contains the request ID. */
-  String requestIdHeaderName();
-
   /** Additional MDC values to include in the log context. */
   Map<String, String> mdc();
 }

runtime/service/src/main/java/org/apache/polaris/service/tracing/DefaultRequestIdGenerator.java

@@ -19,6 +19,7 @@
 
 package org.apache.polaris.service.tracing;
 
+import io.smallrye.common.annotation.Identifier;
 import io.smallrye.mutiny.Uni;
 import jakarta.annotation.Nonnull;
 import jakarta.enterprise.context.ApplicationScoped;
@@ -37,6 +38,7 @@
  * reset to 1.
  */
 @ApplicationScoped
+@Identifier("default")
 public class DefaultRequestIdGenerator implements RequestIdGenerator {
 
   record RequestId(UUID uuid, long counter) {

runtime/service/src/main/java/org/apache/polaris/service/tracing/RequestIdFilter.java

@@ -26,7 +26,6 @@
 import jakarta.ws.rs.core.Response;
 import org.apache.iceberg.rest.responses.ErrorResponse;
 import org.apache.polaris.service.config.FilterPriorities;
-import org.apache.polaris.service.logging.LoggingConfiguration;
 import org.jboss.resteasy.reactive.server.ServerRequestFilter;
 import org.jboss.resteasy.reactive.server.ServerResponseFilter;
 import org.slf4j.Logger;
@@ -38,12 +37,12 @@ public class RequestIdFilter {
 
   private static final Logger LOGGER = LoggerFactory.getLogger(RequestIdFilter.class);
 
-  @Inject LoggingConfiguration loggingConfiguration;
+  @Inject TracingConfiguration tracingConfiguration;
   @Inject RequestIdGenerator requestIdGenerator;
 
   @ServerRequestFilter(preMatching = true, priority = FilterPriorities.REQUEST_ID_FILTER)
   public Uni<Response> assignRequestId(ContainerRequestContext rc) {
-    var requestId = rc.getHeaderString(loggingConfiguration.requestIdHeaderName());
+    var requestId = rc.getHeaderString(tracingConfiguration.requestIdGenerator().headerName());
     return (requestId != null
             ? Uni.createFrom().item(requestId)
             : requestIdGenerator.generateRequestId(rc))
@@ -58,7 +57,7 @@ public void addResponseHeader(
       ContainerRequestContext request, ContainerResponseContext response) {
     String requestId = (String) request.getProperty(REQUEST_ID_KEY);
     if (requestId != null) { // can be null if request ID generation fails
-      response.getHeaders().add(loggingConfiguration.requestIdHeaderName(), requestId);
+      response.getHeaders().add(tracingConfiguration.requestIdGenerator().headerName(), requestId);
     }
   }
 

runtime/service/src/main/java/org/apache/polaris/service/tracing/TracingConfiguration.java

@@ -0,0 +1,42 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *   http://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.apache.polaris.service.tracing;
+
+import io.smallrye.config.ConfigMapping;
+
+@ConfigMapping(prefix = "polaris.tracing")
+public interface TracingConfiguration {
+
+  RequestIdGenerator requestIdGenerator();
+
+  interface RequestIdGenerator {
+
+    /**
+     * The type of the request ID generator. Must be a registered {@link RequestIdGenerator}
+     * identifier.
+     */
+    String type();
+
+    /**
+     * The name of the request header that contains the request ID. Used by the default request ID
+     * generator.
+     */
+    String headerName();
+  }
+}

runtime/service/src/main/resources/META-INF/services/io.smallrye.config.ConfigSourceInterceptor

@@ -0,0 +1,20 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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
+#
+#   http://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.
+#
+
+org.apache.polaris.service.config.ConfigRelocationInterceptor