blob: 0bd7d007adcfd2f9fd7fa39bbec6e3be51f1eafb (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
// 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 com.google.common.collect.ImmutableSetMultimap;
/**
* Wrapper for a {@link Runnable} that copies the {@link LoggingContext} from the current thread to
* the thread that executes the runnable.
*
* <p>The state of the logging context that is copied to the thread that executes the runnable is
* fixed at the creation time of this wrapper. If the runnable is submitted to an executor and is
* executed later this means that changes that are done to the logging context in between creating
* and executing the runnable do not apply.
*
* <p>Example:
*
* <pre>
* try (TraceContext traceContext = TraceContext.newTrace(true, ...)) {
* executor
* .submit(new LoggingContextAwareRunnable(
* () -> {
* // Tracing is enabled since the runnable is created within the TraceContext.
* // Tracing is even enabled if the executor runs the runnable only after the
* // TraceContext was closed.
*
* // The tag "foo=bar" is not set, since it was added to the logging context only
* // after this runnable was created.
*
* // do stuff
* }))
* .get();
* traceContext.addTag("foo", "bar");
* }
* </pre>
*
* @see LoggingContextAwareCallable
*/
public class LoggingContextAwareRunnable implements Runnable {
private final Runnable runnable;
private final Thread callingThread;
private final ImmutableSetMultimap<String, String> tags;
private final boolean forceLogging;
LoggingContextAwareRunnable(Runnable runnable) {
this.runnable = runnable;
this.callingThread = Thread.currentThread();
this.tags = LoggingContext.getInstance().getTagsAsMap();
this.forceLogging = LoggingContext.getInstance().isLoggingForced();
}
public Runnable unwrap() {
return runnable;
}
@Override
public void run() {
if (callingThread.equals(Thread.currentThread())) {
// propagation of logging context is not needed
runnable.run();
return;
}
// propagate logging context
LoggingContext loggingCtx = LoggingContext.getInstance();
ImmutableSetMultimap<String, String> oldTags = loggingCtx.getTagsAsMap();
boolean oldForceLogging = loggingCtx.isLoggingForced();
loggingCtx.setTags(tags);
loggingCtx.forceLogging(forceLogging);
try {
runnable.run();
} finally {
loggingCtx.setTags(oldTags);
loggingCtx.forceLogging(oldForceLogging);
}
}
}
|
