vrajat commented on code in PR #15072: URL: https://github.com/apache/pinot/pull/15072#discussion_r1957745503
########## pinot-core/src/main/java/org/apache/pinot/core/query/executor/MdcExecutor.java: ########## @@ -0,0 +1,159 @@ +/** + * 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.pinot.core.query.executor; + +import java.util.Collection; +import java.util.List; +import java.util.concurrent.Callable; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; +import java.util.stream.Collectors; + + +/** + * A delegator executor service that sets MDC context for the query. + * + * By using this executor, all tasks submitted to the executor will have the MDC context set to the query context. + * This is easier and safer to apply than setting the MDC context manually for each task. + * You can read more about MDC in <a href="https://www.baeldung.com/mdc-in-log4j-2-logback";>this baeldung post</a> + * + * TODO: Convert this class and its usages into an Executor instead of an ExecutorService + * + */ +public abstract class MdcExecutor implements ExecutorService { + private final ExecutorService _executorService; + + public MdcExecutor(ExecutorService executorService) { + _executorService = executorService; + } + + protected abstract boolean alreadyRegistered(); Review Comment: At least with the current implementation, this fn. does not have to be abstract ? Both the implementations are the same. ########## pinot-core/src/main/java/org/apache/pinot/core/query/executor/ServerQueryExecutorV1Impl.java: ########## @@ -140,8 +141,25 @@ public synchronized void shutDown() { @Override public InstanceResponseBlock execute(ServerQueryRequest queryRequest, ExecutorService executorService, @Nullable ResultsBlockStreamer streamer) { + MdcExecutor mdcExecutor = new MdcExecutor(executorService) { + @Override + protected boolean alreadyRegistered() { + return LoggerConstants.QUERY_ID_KEY.isRegistered(); + } + + @Override + protected void registerOnMDC() { + queryRequest.registerOnMdc(); Review Comment: Why go through `queryRequest` to register on MDC ? Instead a call can be made directly to `LoggerConstants.QUERY_ID_KEY` ? ########## pinot-core/src/main/java/org/apache/pinot/core/query/executor/MdcExecutor.java: ########## @@ -0,0 +1,159 @@ +/** + * 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.pinot.core.query.executor; + +import java.util.Collection; +import java.util.List; +import java.util.concurrent.Callable; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; +import java.util.stream.Collectors; + + +/** + * A delegator executor service that sets MDC context for the query. + * + * By using this executor, all tasks submitted to the executor will have the MDC context set to the query context. + * This is easier and safer to apply than setting the MDC context manually for each task. + * You can read more about MDC in <a href="https://www.baeldung.com/mdc-in-log4j-2-logback";>this baeldung post</a> + * + * TODO: Convert this class and its usages into an Executor instead of an ExecutorService + * + */ +public abstract class MdcExecutor implements ExecutorService { Review Comment: In the current scope, this class is only used for query execution threads. So this can be less generic. It can be named `MdcQueryExecutor`. The class can also take in a context then ? The root of my questions are because the following code pattern seems overkill in the current scope. ``` MdcExecutor mdcExecutor = new MdcExecutor(executorService) { @Override protected boolean alreadyRegistered() { return LoggerConstants.QUERY_ID_KEY.isRegistered(); } @Override protected void registerOnMDC() { executionContext.registerOnMDC(); } @Override protected void unregisterFromMDC() { executionContext.unregisterFromMDC(); } }; ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For additional commands, e-mail: commits-h...@pinot.apache.org
