Skip to content

Commit 3986c63

Browse files
trasktrask
committed
Follow SDK naming convention for customizers
1 parent 671b2e9 commit 3986c63

File tree

37 files changed

+541
-78
lines changed

37 files changed

+541
-78
lines changed

‎examples/distro/custom/src/main/java/com/example/javaagent/DemoInstrumenterCustomizerProvider.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ private void customizeHttpServer(InstrumenterCustomizer customizer) {
6666
customizer.addAttributesExtractor(new DemoAttributesExtractor());
6767
customizer.addOperationMetrics(new DemoMetrics());
6868
customizer.addContextCustomizer(new DemoContextCustomizer());
69-
customizer.setSpanNameExtractor(
69+
customizer.setSpanNameExtractorCustomizer(
7070
unused -> (SpanNameExtractor<Object>) object -> "CustomHTTP/" + object.toString());
7171
}
7272

‎examples/extension/src/main/java/com/example/javaagent/DemoInstrumenterCustomizerProvider.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ private void customizeHttpServer(InstrumenterCustomizer customizer) {
6969
customizer.addAttributesExtractor(new DemoAttributesExtractor());
7070
customizer.addOperationMetrics(new DemoMetrics());
7171
customizer.addContextCustomizer(new DemoContextCustomizer());
72-
customizer.setSpanNameExtractor(
72+
customizer.setSpanNameExtractorCustomizer(
7373
unused -> (SpanNameExtractor<Object>) object -> "CustomHTTP/" + object.toString());
7474
}
7575

‎instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/builder/internal/DefaultHttpClientInstrumenterBuilder.java‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,19 @@ public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> addAttributesExtr
111111
return this;
112112
}
113113

114+
/**
115+
* @deprecated Use {@link #setStatusExtractorCustomizer(UnaryOperator)} instead.
116+
*/
117+
@Deprecated
114118
@CanIgnoreReturnValue
115119
public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> setStatusExtractor(
116120
UnaryOperator<SpanStatusExtractor<REQUEST, RESPONSE>> statusExtractor) {
121+
return setStatusExtractorCustomizer(statusExtractor);
122+
}
123+
124+
@CanIgnoreReturnValue
125+
public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> setStatusExtractorCustomizer(
126+
UnaryOperator<SpanStatusExtractor<REQUEST, RESPONSE>> statusExtractor) {
117127
this.statusExtractorTransformer = statusExtractor;
118128
return this;
119129
}
@@ -188,10 +198,22 @@ public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> setRedactQueryPar
188198
return this;
189199
}
190200

191-
/** Sets custom {@link SpanNameExtractor} via transform function. */
201+
/**
202+
* Sets custom {@link SpanNameExtractor} via transform function.
203+
*
204+
* @deprecated Use {@link #setSpanNameExtractorCustomizer(UnaryOperator)} instead.
205+
*/
206+
@Deprecated
192207
@CanIgnoreReturnValue
193208
public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> setSpanNameExtractor(
194209
UnaryOperator<SpanNameExtractor<REQUEST>> spanNameExtractor) {
210+
return setSpanNameExtractorCustomizer(spanNameExtractor);
211+
}
212+
213+
/** Sets custom {@link SpanNameExtractor} via transform function. */
214+
@CanIgnoreReturnValue
215+
public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> setSpanNameExtractorCustomizer(
216+
UnaryOperator<SpanNameExtractor<REQUEST>> spanNameExtractor) {
195217
this.spanNameExtractorTransformer = spanNameExtractor;
196218
return this;
197219
}

‎instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/builder/internal/DefaultHttpServerInstrumenterBuilder.java‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,19 @@ public DefaultHttpServerInstrumenterBuilder<REQUEST, RESPONSE> addAttributesExtr
106106
return this;
107107
}
108108

109+
/**
110+
* @deprecated Use {@link #setStatusExtractorCustomizer(UnaryOperator)} instead.
111+
*/
112+
@Deprecated
109113
@CanIgnoreReturnValue
110114
public DefaultHttpServerInstrumenterBuilder<REQUEST, RESPONSE> setStatusExtractor(
111115
UnaryOperator<SpanStatusExtractor<REQUEST, RESPONSE>> statusExtractor) {
116+
return setStatusExtractorCustomizer(statusExtractor);
117+
}
118+
119+
@CanIgnoreReturnValue
120+
public DefaultHttpServerInstrumenterBuilder<REQUEST, RESPONSE> setStatusExtractorCustomizer(
121+
UnaryOperator<SpanStatusExtractor<REQUEST, RESPONSE>> statusExtractor) {
112122
this.statusExtractorTransformer = statusExtractor;
113123
return this;
114124
}
@@ -172,10 +182,22 @@ public DefaultHttpServerInstrumenterBuilder<REQUEST, RESPONSE> setKnownMethods(
172182
return this;
173183
}
174184

175-
/** Sets custom {@link SpanNameExtractor} via transform function. */
185+
/**
186+
* Sets custom {@link SpanNameExtractor} via transform function.
187+
*
188+
* @deprecated Use {@link #setSpanNameExtractorCustomizer(UnaryOperator)} instead.
189+
*/
190+
@Deprecated
176191
@CanIgnoreReturnValue
177192
public DefaultHttpServerInstrumenterBuilder<REQUEST, RESPONSE> setSpanNameExtractor(
178193
UnaryOperator<SpanNameExtractor<REQUEST>> spanNameExtractor) {
194+
return setSpanNameExtractorCustomizer(spanNameExtractor);
195+
}
196+
197+
/** Sets custom {@link SpanNameExtractor} via transform function. */
198+
@CanIgnoreReturnValue
199+
public DefaultHttpServerInstrumenterBuilder<REQUEST, RESPONSE> setSpanNameExtractorCustomizer(
200+
UnaryOperator<SpanNameExtractor<REQUEST>> spanNameExtractor) {
179201
this.spanNameExtractorTransformer = spanNameExtractor;
180202
return this;
181203
}

‎instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/instrumenter/InstrumenterCustomizer.java‎

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,18 +87,46 @@ InstrumenterCustomizer addAttributesExtractors(
8787
*
8888
* @param spanNameExtractor function that transforms the original span name extractor
8989
* @return this InstrumenterCustomizer for method chaining
90+
* @deprecated Use {@link #setSpanNameExtractorCustomizer(UnaryOperator)} instead.
9091
*/
91-
InstrumenterCustomizer setSpanNameExtractor(
92+
@Deprecated
93+
default InstrumenterCustomizer setSpanNameExtractor(
94+
UnaryOperator<SpanNameExtractor<?>> spanNameExtractor) {
95+
return setSpanNameExtractorCustomizer(spanNameExtractor);
96+
}
97+
98+
/**
99+
* Sets a transformer function that will modify the {@link SpanNameExtractor}. This allows
100+
* customizing how span names are generated for the instrumented operations.
101+
*
102+
* @param spanNameExtractor function that transforms the original span name extractor
103+
* @return this InstrumenterCustomizer for method chaining
104+
*/
105+
InstrumenterCustomizer setSpanNameExtractorCustomizer(
92106
UnaryOperator<SpanNameExtractor<?>> spanNameExtractor);
93107

108+
/**
109+
* Sets a transformer function that will modify the {@link SpanStatusExtractor}. This allows
110+
* customizing how span statuses are generated for the instrumented operations.
111+
*
112+
* @param spanStatusExtractor function that transforms the original span status extractor
113+
* @return this InstrumenterCustomizer for method chaining
114+
* @deprecated Use {@link #setSpanStatusExtractorCustomizer(UnaryOperator)} instead.
115+
*/
116+
@Deprecated
117+
default InstrumenterCustomizer setSpanStatusExtractor(
118+
UnaryOperator<SpanStatusExtractor<?, ?>> spanStatusExtractor) {
119+
return setSpanStatusExtractorCustomizer(spanStatusExtractor);
120+
}
121+
94122
/**
95123
* Sets a transformer function that will modify the {@link SpanStatusExtractor}. This allows
96124
* customizing how span statuses are generated for the instrumented operations.
97125
*
98126
* @param spanStatusExtractor function that transforms the original span status extractor
99127
* @return this InstrumenterCustomizer for method chaining
100128
*/
101-
InstrumenterCustomizer setSpanStatusExtractor(
129+
InstrumenterCustomizer setSpanStatusExtractorCustomizer(
102130
UnaryOperator<SpanStatusExtractor<?, ?>> spanStatusExtractor);
103131

104132
/** Types of instrumentation. */

‎instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/instrumenter/internal/InstrumenterCustomizerImpl.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,16 +83,16 @@ public InstrumenterCustomizer addContextCustomizer(ContextCustomizer<?> customiz
8383

8484
@Override
8585
@SuppressWarnings("FunctionalInterfaceClash") // interface has deprecated overload
86-
public InstrumenterCustomizer setSpanNameExtractor(
86+
public InstrumenterCustomizer setSpanNameExtractorCustomizer(
8787
UnaryOperator<SpanNameExtractor<?>> spanNameExtractor) {
88-
customizer.setSpanNameExtractor(spanNameExtractor);
88+
customizer.setSpanNameExtractorCustomizer(spanNameExtractor);
8989
return this;
9090
}
9191

9292
@Override
93-
public InstrumenterCustomizer setSpanStatusExtractor(
93+
public InstrumenterCustomizer setSpanStatusExtractorCustomizer(
9494
UnaryOperator<SpanStatusExtractor<?, ?>> spanStatusExtractor) {
95-
customizer.setSpanStatusExtractor(spanStatusExtractor);
95+
customizer.setSpanStatusExtractorCustomizer(spanStatusExtractor);
9696
return this;
9797
}
9898
}

‎instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/instrumenter/InstrumenterBuilder.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -437,14 +437,14 @@ public void addContextCustomizer(ContextCustomizer<REQUEST> customizer) {
437437
}
438438

439439
@Override
440-
public void setSpanNameExtractor(
440+
public void setSpanNameExtractorCustomizer(
441441
UnaryOperator<SpanNameExtractor<? super REQUEST>> spanNameExtractorTransformer) {
442442
builder.spanNameExtractor =
443443
spanNameExtractorTransformer.apply(builder.spanNameExtractor);
444444
}
445445

446446
@Override
447-
public void setSpanStatusExtractor(
447+
public void setSpanStatusExtractorCustomizer(
448448
UnaryOperator<SpanStatusExtractor<? super REQUEST, ? super RESPONSE>>
449449
spanStatusExtractorTransformer) {
450450
builder.spanStatusExtractor =

‎instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/internal/InternalInstrumenterCustomizer.java‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,29 @@ void addAttributesExtractors(
3131

3232
void addContextCustomizer(ContextCustomizer<REQUEST> customizer);
3333

34-
void setSpanNameExtractor(
34+
/**
35+
* @deprecated Use {@link #setSpanNameExtractorCustomizer(UnaryOperator)} instead.
36+
*/
37+
@Deprecated
38+
default void setSpanNameExtractor(
39+
UnaryOperator<SpanNameExtractor<? super REQUEST>> spanNameExtractorTransformer) {
40+
setSpanNameExtractorCustomizer(spanNameExtractorTransformer);
41+
}
42+
43+
void setSpanNameExtractorCustomizer(
3544
UnaryOperator<SpanNameExtractor<? super REQUEST>> spanNameExtractorTransformer);
3645

37-
void setSpanStatusExtractor(
46+
/**
47+
* @deprecated Use {@link #setSpanStatusExtractorCustomizer(UnaryOperator)} instead.
48+
*/
49+
@Deprecated
50+
default void setSpanStatusExtractor(
51+
UnaryOperator<SpanStatusExtractor<? super REQUEST, ? super RESPONSE>>
52+
spanStatusExtractorTransformer) {
53+
setSpanStatusExtractorCustomizer(spanStatusExtractorTransformer);
54+
}
55+
56+
void setSpanStatusExtractorCustomizer(
3857
UnaryOperator<SpanStatusExtractor<? super REQUEST, ? super RESPONSE>>
3958
spanStatusExtractorTransformer);
4059
}

‎instrumentation-api/src/test/java/io/opentelemetry/instrumentation/api/internal/InstrumentationCustomizerTest.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ void testSetSpanNameExtractor() {
327327
setCustomizer(
328328
customizer -> {
329329
customizerCalled.set(true);
330-
customizer.setSpanNameExtractor(
330+
customizer.setSpanNameExtractorCustomizer(
331331
unused -> (SpanNameExtractor<Object>) object -> "new name");
332332
});
333333

@@ -366,7 +366,7 @@ void testSetSpanStatusExtractor() {
366366
setCustomizer(
367367
customizer -> {
368368
customizerCalled.set(true);
369-
customizer.setSpanStatusExtractor(
369+
customizer.setSpanStatusExtractorCustomizer(
370370
unused ->
371371
(spanStatusBuilder, request, response, error) ->
372372
spanStatusBuilder.setStatus(StatusCode.OK));

‎instrumentation/apache-dubbo-2.7/library-autoconfigure/src/main/java/io/opentelemetry/instrumentation/apachedubbo/v2_7/DubboTelemetryBuilder.java‎

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,18 +63,42 @@ public DubboTelemetryBuilder addAttributesExtractor(
6363
return this;
6464
}
6565

66-
/** Sets custom client {@link SpanNameExtractor} via transform function. */
66+
/**
67+
* Sets custom client {@link SpanNameExtractor} via transform function.
68+
*
69+
* @deprecated Use {@link #setClientSpanNameExtractorCustomizer(UnaryOperator)} instead.
70+
*/
71+
@Deprecated
6772
@CanIgnoreReturnValue
6873
public DubboTelemetryBuilder setClientSpanNameExtractor(
6974
UnaryOperator<SpanNameExtractor<DubboRequest>> clientSpanNameExtractor) {
75+
return setClientSpanNameExtractorCustomizer(clientSpanNameExtractor);
76+
}
77+
78+
/** Sets custom client {@link SpanNameExtractor} via transform function. */
79+
@CanIgnoreReturnValue
80+
public DubboTelemetryBuilder setClientSpanNameExtractorCustomizer(
81+
UnaryOperator<SpanNameExtractor<DubboRequest>> clientSpanNameExtractor) {
7082
this.clientSpanNameExtractorTransformer = clientSpanNameExtractor;
7183
return this;
7284
}
7385

74-
/** Sets custom server {@link SpanNameExtractor} via transform function. */
86+
/**
87+
* Sets custom server {@link SpanNameExtractor} via transform function.
88+
*
89+
* @deprecated Use {@link #setServerSpanNameExtractorCustomizer(UnaryOperator)} instead.
90+
*/
91+
@Deprecated
7592
@CanIgnoreReturnValue
7693
public DubboTelemetryBuilder setServerSpanNameExtractor(
7794
UnaryOperator<SpanNameExtractor<DubboRequest>> serverSpanNameExtractor) {
95+
return setServerSpanNameExtractorCustomizer(serverSpanNameExtractor);
96+
}
97+
98+
/** Sets custom server {@link SpanNameExtractor} via transform function. */
99+
@CanIgnoreReturnValue
100+
public DubboTelemetryBuilder setServerSpanNameExtractorCustomizer(
101+
UnaryOperator<SpanNameExtractor<DubboRequest>> serverSpanNameExtractor) {
78102
this.serverSpanNameExtractorTransformer = serverSpanNameExtractor;
79103
return this;
80104
}

0 commit comments

Comments
 (0)