We used a custom ThreadFactory to copy the LoggingContext to newly created threads, but this is not sufficient since the new thread may be cached in a thread pool and then be reused to execute further tasks. We must copy the LoggingContext each time a task is executed in a background thread, not only when the background thread is created. To copy the LoggingContext when a Runnable or Callable is executed in the background we implement LoggingContext aware wrappers for them. We use 2 ways for executing tasks in background threads: 1. ExecutorService/ScheduledExecutorService 2. WorkQueue.Executor (custom executor) To ensure the copying of the LoggingContext when a task is executed in the background we now do: 1. Wrap each ExecutorService/ScheduledExecutorService with a wrapper that wraps each Runnable/Callable that is passed in with a LoggingContext aware wrapper. 2. Wrap each Runnable/Callable that is passed into WorkQueue.Executor with a LoggingContext aware wrapper. For WorkQueue.Executor we would ideally wrap the Runnable/Callable in decorateTask but the Runnable/Callable that is being executed is contained in a RunnableScheduledFuture and we cannot access it (decorateTask in ScheduledThreadPoolExecutor from which we inherit ignores the passed in Runnable and only the passed in RunnableScheduledFuture is relevant). Also overriding the newTaskFor(Runnable)/newTaskFor(Callable) methods does not work since ScheduledThreadPoolExecutor is creating tasks directly without invoking any newTaskFor method. Change-Id: I106dcdf6478c58dfa6fe1d7952a87aa16ead1a93 Signed-off-by: Edwin Kempin <ekempin@google.com>
60 lines
2.3 KiB
Java
60 lines
2.3 KiB
Java
// Copyright (C) 2018 The Android Open Source Project
|
|
//
|
|
// 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
|
|
//
|
|
// 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 com.google.gerrit.server.logging;
|
|
|
|
import java.util.concurrent.Callable;
|
|
import java.util.concurrent.ScheduledExecutorService;
|
|
import java.util.concurrent.ScheduledFuture;
|
|
import java.util.concurrent.TimeUnit;
|
|
|
|
/**
|
|
* A {@link ScheduledExecutorService} that copies the {@link LoggingContext} on executing a {@link
|
|
* Runnable} to the executing thread.
|
|
*/
|
|
public class LoggingContextAwareScheduledExecutorService extends LoggingContextAwareExecutorService
|
|
implements ScheduledExecutorService {
|
|
private final ScheduledExecutorService scheduledExecutorService;
|
|
|
|
public LoggingContextAwareScheduledExecutorService(
|
|
ScheduledExecutorService scheduledExecutorService) {
|
|
super(scheduledExecutorService);
|
|
this.scheduledExecutorService = scheduledExecutorService;
|
|
}
|
|
|
|
@Override
|
|
public ScheduledFuture<?> schedule(Runnable command, long delay, TimeUnit unit) {
|
|
return scheduledExecutorService.schedule(LoggingContext.copy(command), delay, unit);
|
|
}
|
|
|
|
@Override
|
|
public <V> ScheduledFuture<V> schedule(Callable<V> callable, long delay, TimeUnit unit) {
|
|
return scheduledExecutorService.schedule(LoggingContext.copy(callable), delay, unit);
|
|
}
|
|
|
|
@Override
|
|
public ScheduledFuture<?> scheduleAtFixedRate(
|
|
Runnable command, long initialDelay, long period, TimeUnit unit) {
|
|
return scheduledExecutorService.scheduleAtFixedRate(
|
|
LoggingContext.copy(command), initialDelay, period, unit);
|
|
}
|
|
|
|
@Override
|
|
public ScheduledFuture<?> scheduleWithFixedDelay(
|
|
Runnable command, long initialDelay, long delay, TimeUnit unit) {
|
|
return scheduledExecutorService.scheduleWithFixedDelay(
|
|
LoggingContext.copy(command), initialDelay, delay, unit);
|
|
}
|
|
}
|