Skip to content

Commit 670f193

Browse files
committed
Merge PR #243: Update baggage-processor module to follow style guide
2 parents 6bd5eb6 + 58c2195 commit 670f193

File tree

6 files changed

+29
-22
lines changed

6 files changed

+29
-22
lines changed

baggage-processor/build.gradle.kts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,13 @@ dependencies {
1212
api("io.opentelemetry:opentelemetry-sdk")
1313
implementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure-spi")
1414

15+
compileOnly("com.google.auto.service:auto-service-annotations")
16+
annotationProcessor("com.google.auto.service:auto-service")
17+
1518
testImplementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")
1619
testImplementation("io.opentelemetry:opentelemetry-sdk-testing")
1720
testImplementation("org.mockito:mockito-inline")
1821
testImplementation("com.google.guava:guava")
1922
testImplementation("org.awaitility:awaitility")
23+
testCompileOnly("com.google.auto.service:auto-service-annotations")
2024
}

baggage-processor/src/main/java/io/opentelemetry/contrib/baggage/processor/BaggageLogRecordProcessor.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,7 @@
1616
* This log record processor copies attributes stored in {@link Baggage} into each newly created log
1717
* record.
1818
*/
19-
public class BaggageLogRecordProcessor implements LogRecordProcessor {
20-
21-
/**
22-
* Creates a new {@link BaggageLogRecordProcessor} that copies all baggage entries into the newly
23-
* created log record.
24-
*/
25-
public static BaggageLogRecordProcessor allowAllBaggageKeys() {
26-
return new BaggageLogRecordProcessor(baggageKey -> true);
27-
}
19+
public final class BaggageLogRecordProcessor implements LogRecordProcessor {
2820

2921
private final Predicate<String> baggageKeyPredicate;
3022

@@ -36,6 +28,14 @@ public BaggageLogRecordProcessor(Predicate<String> baggageKeyPredicate) {
3628
this.baggageKeyPredicate = baggageKeyPredicate;
3729
}
3830

31+
/**
32+
* Creates a new {@link BaggageLogRecordProcessor} that copies all baggage entries into the newly
33+
* created log record.
34+
*/
35+
public static BaggageLogRecordProcessor allowAllBaggageKeys() {
36+
return new BaggageLogRecordProcessor(baggageKey -> true);
37+
}
38+
3939
@Override
4040
public void onEmit(Context context, ReadWriteLogRecord logRecord) {
4141
Baggage.fromContext(context)

baggage-processor/src/main/java/io/opentelemetry/contrib/baggage/processor/BaggageProcessorCustomizer.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,16 @@
55

66
package io.opentelemetry.contrib.baggage.processor;
77

8+
import com.google.auto.service.AutoService;
89
import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer;
910
import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider;
1011
import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
1112
import io.opentelemetry.sdk.logs.SdkLoggerProviderBuilder;
1213
import io.opentelemetry.sdk.trace.SdkTracerProviderBuilder;
1314
import java.util.List;
1415

15-
public class BaggageProcessorCustomizer implements AutoConfigurationCustomizerProvider {
16+
@AutoService(AutoConfigurationCustomizerProvider.class)
17+
public final class BaggageProcessorCustomizer implements AutoConfigurationCustomizerProvider {
1618
@Override
1719
public void customize(AutoConfigurationCustomizer autoConfigurationCustomizer) {
1820
autoConfigurationCustomizer

baggage-processor/src/main/java/io/opentelemetry/contrib/baggage/processor/BaggageSpanProcessor.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* This span processor copies attributes stored in {@link Baggage} into each newly created {@link
1717
* io.opentelemetry.api.trace.Span}.
1818
*/
19-
public class BaggageSpanProcessor implements SpanProcessor {
19+
public final class BaggageSpanProcessor implements SpanProcessor {
2020
private final Predicate<String> baggageKeyPredicate;
2121

2222
/**

baggage-processor/src/main/resources/META-INF/services/io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider

Lines changed: 0 additions & 1 deletion
This file was deleted.

baggage-processor/src/test/java/io/opentelemetry/contrib/baggage/processor/BaggageSpanProcessorTest.java

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55

66
package io.opentelemetry.contrib.baggage.processor;
77

8+
import static org.mockito.Mockito.never;
9+
import static org.mockito.Mockito.verify;
10+
811
import io.opentelemetry.api.baggage.Baggage;
912
import io.opentelemetry.context.Context;
1013
import io.opentelemetry.context.Scope;
@@ -13,24 +16,23 @@
1316
import org.junit.jupiter.api.Test;
1417
import org.junit.jupiter.api.extension.ExtendWith;
1518
import org.mockito.Mock;
16-
import org.mockito.Mockito;
1719
import org.mockito.junit.jupiter.MockitoExtension;
1820

1921
@ExtendWith(MockitoExtension.class)
20-
public class BaggageSpanProcessorTest {
22+
class BaggageSpanProcessorTest {
2123

2224
@Test
23-
public void test_baggageSpanProcessor_adds_attributes_to_spans(@Mock ReadWriteSpan span) {
25+
void test_baggageSpanProcessor_adds_attributes_to_spans(@Mock ReadWriteSpan span) {
2426
try (BaggageSpanProcessor processor = BaggageSpanProcessor.allowAllBaggageKeys()) {
2527
try (Scope ignore = Baggage.current().toBuilder().put("key", "value").build().makeCurrent()) {
2628
processor.onStart(Context.current(), span);
27-
Mockito.verify(span).setAttribute("key", "value");
29+
verify(span).setAttribute("key", "value");
2830
}
2931
}
3032
}
3133

3234
@Test
33-
public void test_baggageSpanProcessor_adds_attributes_to_spans_when_key_filter_matches(
35+
void test_baggageSpanProcessor_adds_attributes_to_spans_when_key_filter_matches(
3436
@Mock ReadWriteSpan span) {
3537
try (BaggageSpanProcessor processor = new BaggageSpanProcessor(key -> key.startsWith("k"))) {
3638
try (Scope ignore =
@@ -40,14 +42,14 @@ public void test_baggageSpanProcessor_adds_attributes_to_spans_when_key_filter_m
4042
.build()
4143
.makeCurrent()) {
4244
processor.onStart(Context.current(), span);
43-
Mockito.verify(span).setAttribute("key", "value");
44-
Mockito.verify(span, Mockito.never()).setAttribute("other", "value");
45+
verify(span).setAttribute("key", "value");
46+
verify(span, never()).setAttribute("other", "value");
4547
}
4648
}
4749
}
4850

4951
@Test
50-
public void test_baggageSpanProcessor_adds_attributes_to_spans_when_key_filter_matches_regex(
52+
void test_baggageSpanProcessor_adds_attributes_to_spans_when_key_filter_matches_regex(
5153
@Mock ReadWriteSpan span) {
5254
Pattern pattern = Pattern.compile("k.*");
5355
try (BaggageSpanProcessor processor =
@@ -59,8 +61,8 @@ public void test_baggageSpanProcessor_adds_attributes_to_spans_when_key_filter_m
5961
.build()
6062
.makeCurrent()) {
6163
processor.onStart(Context.current(), span);
62-
Mockito.verify(span).setAttribute("key", "value");
63-
Mockito.verify(span, Mockito.never()).setAttribute("other", "value");
64+
verify(span).setAttribute("key", "value");
65+
verify(span, never()).setAttribute("other", "value");
6466
}
6567
}
6668
}

0 commit comments

Comments
 (0)