Skip to content

Commit 2312400

Browse files
Excavator: Migrate to the logsafe SafeLogger API (#752)
1 parent 5efa9c8 commit 2312400

File tree

8 files changed

+21
-16
lines changed

8 files changed

+21
-16
lines changed

tracing-servlet/build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ dependencies {
2424
// servlet-api should be the only exposed dependency
2525
api "jakarta.servlet:jakarta.servlet-api"
2626

27-
implementation "org.slf4j:slf4j-api"
27+
implementation 'com.palantir.safe-logging:logger'
2828

2929
testImplementation "io.dropwizard:dropwizard-testing"
3030
testImplementation "junit:junit"

tracing-servlet/src/main/java/com/palantir/tracing/servlet/LeakedTraceFilter.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818

1919
import com.palantir.logsafe.SafeArg;
2020
import com.palantir.logsafe.UnsafeArg;
21+
import com.palantir.logsafe.logger.SafeLogger;
22+
import com.palantir.logsafe.logger.SafeLoggerFactory;
2123
import com.palantir.tracing.Trace;
2224
import com.palantir.tracing.Tracer;
2325
import java.io.IOException;
@@ -29,8 +31,6 @@
2931
import javax.servlet.ServletRequest;
3032
import javax.servlet.ServletResponse;
3133
import javax.servlet.http.HttpServletRequest;
32-
import org.slf4j.Logger;
33-
import org.slf4j.LoggerFactory;
3434

3535
/**
3636
* Guarantees clean {@link Tracer} thread state for incoming requests. This {@link Filter} logs at
@@ -41,7 +41,7 @@
4141
* by this filter has leaked state.
4242
*/
4343
public final class LeakedTraceFilter implements Filter {
44-
private static final Logger log = LoggerFactory.getLogger(LeakedTraceFilter.class);
44+
private static final SafeLogger log = SafeLoggerFactory.get(LeakedTraceFilter.class);
4545

4646
@Override
4747
public void init(FilterConfig _value) {

tracing-undertow/build.gradle

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ dependencies {
2424
implementation project(':tracing-api')
2525
implementation 'com.google.guava:guava'
2626
implementation 'com.palantir.safe-logging:preconditions'
27+
implementation 'com.palantir.safe-logging:logger'
2728

2829
// Required for tests using the slf4j MDC which is not implemented in slf4j-simple
2930
testImplementation 'ch.qos.logback:logback-classic'

tracing-undertow/src/main/java/com/palantir/tracing/undertow/UndertowTracing.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
import com.google.common.base.Strings;
2121
import com.palantir.logsafe.SafeArg;
2222
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
23+
import com.palantir.logsafe.logger.SafeLogger;
24+
import com.palantir.logsafe.logger.SafeLoggerFactory;
2325
import com.palantir.tracing.DetachedSpan;
2426
import com.palantir.tracing.InternalTracers;
2527
import com.palantir.tracing.Observability;
@@ -33,16 +35,14 @@
3335
import io.undertow.util.HeaderMap;
3436
import io.undertow.util.HttpString;
3537
import java.util.Optional;
36-
import org.slf4j.Logger;
37-
import org.slf4j.LoggerFactory;
3838

3939
/**
4040
* Internal utility functionality shared between {@link TracedOperationHandler} and {@link TracedRequestHandler}.
4141
* Intentionally package private.
4242
*/
4343
final class UndertowTracing {
4444

45-
private static final Logger log = LoggerFactory.getLogger(UndertowTracing.class);
45+
private static final SafeLogger log = SafeLoggerFactory.get(UndertowTracing.class);
4646

4747
// Tracing header definitions
4848
private static final HttpString TRACE_ID = HttpString.tryFromString(TraceHttpHeaders.TRACE_ID);

tracing/build.gradle

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ dependencies {
2626
compile "com.palantir.safe-logging:safe-logging"
2727
compile "org.slf4j:slf4j-api"
2828

29+
implementation 'com.palantir.safe-logging:logger'
2930
implementation 'com.fasterxml.jackson.core:jackson-annotations'
3031
implementation 'com.fasterxml.jackson.core:jackson-core'
3132
implementation 'com.google.code.findbugs:jsr305'

tracing/src/main/java/com/palantir/tracing/AsyncSpanObserver.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,17 @@
2222
import com.google.common.util.concurrent.ListeningExecutorService;
2323
import com.google.common.util.concurrent.MoreExecutors;
2424
import com.palantir.logsafe.SafeArg;
25+
import com.palantir.logsafe.logger.SafeLogger;
26+
import com.palantir.logsafe.logger.SafeLoggerFactory;
2527
import com.palantir.tracing.api.Span;
2628
import com.palantir.tracing.api.SpanObserver;
2729
import java.util.concurrent.ExecutorService;
2830
import java.util.concurrent.atomic.AtomicInteger;
29-
import org.slf4j.Logger;
30-
import org.slf4j.LoggerFactory;
3131

3232
/** A {@link SpanObserver} whose observations are executed on a supplied {@link ExecutorService}. */
3333
public abstract class AsyncSpanObserver implements SpanObserver {
3434

35-
private static final Logger log = LoggerFactory.getLogger(AsyncSpanObserver.class);
35+
private static final SafeLogger log = SafeLoggerFactory.get(AsyncSpanObserver.class);
3636
private static final int DEFAULT_MAX_INFLIGHTS = 10_000;
3737

3838
private final ListeningExecutorService executorService;

tracing/src/main/java/com/palantir/tracing/Tracer.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@
3030
import com.palantir.logsafe.exceptions.SafeIllegalArgumentException;
3131
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
3232
import com.palantir.logsafe.exceptions.SafeRuntimeException;
33+
import com.palantir.logsafe.logger.SafeLogger;
34+
import com.palantir.logsafe.logger.SafeLoggerFactory;
3335
import com.palantir.tracing.api.OpenSpan;
3436
import com.palantir.tracing.api.Span;
3537
import com.palantir.tracing.api.SpanObserver;
@@ -41,8 +43,6 @@
4143
import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
4244
import java.util.function.Consumer;
4345
import javax.annotation.Nullable;
44-
import org.slf4j.Logger;
45-
import org.slf4j.LoggerFactory;
4646
import org.slf4j.MDC;
4747

4848
/**
@@ -53,7 +53,7 @@
5353
*/
5454
public final class Tracer {
5555

56-
private static final Logger log = LoggerFactory.getLogger(Tracer.class);
56+
private static final SafeLogger log = SafeLoggerFactory.get(Tracer.class);
5757

5858
private Tracer() {}
5959

versions.lock

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,16 @@ com.fasterxml.jackson.core:jackson-core:2.12.3 (18 constraints: f5617cda)
55
com.fasterxml.jackson.core:jackson-databind:2.12.3 (26 constraints: 8cf4d2b4)
66
com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.12.3 (4 constraints: 1e3f528b)
77
com.google.code.findbugs:jsr305:3.0.2 (16 constraints: 50e8dc30)
8-
com.google.errorprone:error_prone_annotations:2.5.1 (3 constraints: 1c2b3fe9)
8+
com.google.errorprone:error_prone_annotations:2.5.1 (6 constraints: ab58734d)
99
com.google.guava:failureaccess:1.0.1 (1 constraints: 140ae1b4)
1010
com.google.guava:guava:28.2-jre (6 constraints: 5d5b5723)
1111
com.google.guava:listenablefuture:9999.0-empty-to-avoid-conflict-with-guava (1 constraints: bd17c918)
1212
com.google.j2objc:j2objc-annotations:1.3 (1 constraints: b809eda0)
13+
com.palantir.safe-logging:logger:1.18.0 (1 constraints: 3c05413b)
14+
com.palantir.safe-logging:logger-slf4j:1.18.0 (1 constraints: 350e9350)
15+
com.palantir.safe-logging:logger-spi:1.18.0 (2 constraints: 791e0cb1)
1316
com.palantir.safe-logging:preconditions:1.18.0 (3 constraints: 19364d74)
14-
com.palantir.safe-logging:safe-logging:1.18.0 (3 constraints: cf2ab885)
17+
com.palantir.safe-logging:safe-logging:1.18.0 (5 constraints: b0485624)
1518
com.squareup.okhttp3:okhttp:3.9.0 (1 constraints: 0e051536)
1619
com.squareup.okio:okio:1.13.0 (1 constraints: 7f0cb509)
1720
io.undertow:undertow-core:2.0.17.Final (1 constraints: 54072861)
@@ -34,7 +37,7 @@ org.jboss.xnio:xnio-api:3.3.8.Final (2 constraints: 6f1a4d45)
3437
org.jboss.xnio:xnio-nio:3.3.8.Final (1 constraints: c40da530)
3538
org.openjdk.jmh:jmh-core:1.32 (2 constraints: ed155dd8)
3639
org.openjdk.jmh:jmh-generator-annprocess:1.32 (1 constraints: da04f730)
37-
org.slf4j:slf4j-api:1.7.31 (25 constraints: a06b8313)
40+
org.slf4j:slf4j-api:1.7.31 (26 constraints: e67b4d74)
3841

3942
[Test dependencies]
4043
ch.qos.logback:logback-access:1.2.3 (1 constraints: b41148e2)

0 commit comments

Comments
 (0)