Skip to content

Commit 4cc4e1c

Browse files
trasktrask
authored
Consistent naming of addAttributesExtractor (#12860)
1 parent 39a6bca commit 4cc4e1c

File tree

19 files changed

+145
-21
lines changed

19 files changed

+145
-21
lines changed

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ public static <REQUEST, RESPONSE> DefaultHttpClientInstrumenterBuilder<REQUEST,
103103
* items. The {@link AttributesExtractor} will be executed after all default extractors.
104104
*/
105105
@CanIgnoreReturnValue
106-
public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> addAttributeExtractor(
106+
public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> addAttributesExtractor(
107107
AttributesExtractor<? super REQUEST, ? super RESPONSE> attributesExtractor) {
108108
additionalExtractors.add(attributesExtractor);
109109
return this;
@@ -190,15 +190,15 @@ public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> setSpanNameExtrac
190190
@CanIgnoreReturnValue
191191
public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> setPeerServiceResolver(
192192
PeerServiceResolver peerServiceResolver) {
193-
return addAttributeExtractor(
193+
return addAttributesExtractor(
194194
HttpClientPeerServiceAttributesExtractor.create(attributesGetter, peerServiceResolver));
195195
}
196196

197197
/** Sets the {@code peer.service} attribute for http client spans. */
198198
@CanIgnoreReturnValue
199199
public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> setPeerService(
200200
String peerService) {
201-
return addAttributeExtractor(AttributesExtractor.constant(PEER_SERVICE, peerService));
201+
return addAttributesExtractor(AttributesExtractor.constant(PEER_SERVICE, peerService));
202202
}
203203

204204
@CanIgnoreReturnValue

‎instrumentation/apache-httpclient/apache-httpclient-4.3/library/src/main/java/io/opentelemetry/instrumentation/apachehttpclient/v4_3/ApacheHttpClientTelemetryBuilder.java

+16-1
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,27 @@ public final class ApacheHttpClientTelemetryBuilder {
3333
/**
3434
* Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
3535
* items. The {@link AttributesExtractor} will be executed after all default extractors.
36+
*
37+
* @deprecated Use {@link #addAttributesExtractor(AttributesExtractor)} instead.
3638
*/
39+
@Deprecated
3740
@CanIgnoreReturnValue
3841
public ApacheHttpClientTelemetryBuilder addAttributeExtractor(
3942
AttributesExtractor<? super ApacheHttpClientRequest, ? super HttpResponse>
4043
attributesExtractor) {
41-
builder.addAttributeExtractor(attributesExtractor);
44+
builder.addAttributesExtractor(attributesExtractor);
45+
return this;
46+
}
47+
48+
/**
49+
* Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
50+
* items. The {@link AttributesExtractor} will be executed after all default extractors.
51+
*/
52+
@CanIgnoreReturnValue
53+
public ApacheHttpClientTelemetryBuilder addAttributesExtractor(
54+
AttributesExtractor<? super ApacheHttpClientRequest, ? super HttpResponse>
55+
attributesExtractor) {
56+
builder.addAttributesExtractor(attributesExtractor);
4257
return this;
4358
}
4459

‎instrumentation/apache-httpclient/apache-httpclient-5.2/library/src/main/java/io/opentelemetry/instrumentation/apachehttpclient/v5_2/ApacheHttpClient5TelemetryBuilder.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public final class ApacheHttpClient5TelemetryBuilder {
3939
public ApacheHttpClient5TelemetryBuilder addAttributeExtractor(
4040
AttributesExtractor<? super ApacheHttpClient5Request, ? super HttpResponse>
4141
attributesExtractor) {
42-
builder.addAttributeExtractor(attributesExtractor);
42+
builder.addAttributesExtractor(attributesExtractor);
4343
return this;
4444
}
4545

‎instrumentation/armeria/armeria-1.3/library/src/main/java/io/opentelemetry/instrumentation/armeria/v1_3/ArmeriaTelemetryBuilder.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ public ArmeriaTelemetryBuilder setServerStatusExtractor(
9595
@CanIgnoreReturnValue
9696
public ArmeriaTelemetryBuilder addAttributeExtractor(
9797
AttributesExtractor<? super RequestContext, ? super RequestLog> attributesExtractor) {
98-
clientBuilder.addAttributeExtractor(attributesExtractor);
98+
clientBuilder.addAttributesExtractor(attributesExtractor);
9999
serverBuilder.addAttributesExtractor(attributesExtractor);
100100
return this;
101101
}
@@ -108,7 +108,7 @@ public ArmeriaTelemetryBuilder addAttributeExtractor(
108108
@CanIgnoreReturnValue
109109
public ArmeriaTelemetryBuilder addClientAttributeExtractor(
110110
AttributesExtractor<? super ClientRequestContext, ? super RequestLog> attributesExtractor) {
111-
clientBuilder.addAttributeExtractor(attributesExtractor);
111+
clientBuilder.addAttributesExtractor(attributesExtractor);
112112
return this;
113113
}
114114

‎instrumentation/grpc-1.6/library/src/main/java/io/opentelemetry/instrumentation/grpc/v1_6/GrpcTelemetryBuilder.java

+14
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,28 @@ public final class GrpcTelemetryBuilder {
5959
/**
6060
* Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
6161
* items. The {@link AttributesExtractor} will be executed after all default extractors.
62+
*
63+
* @deprecated Use {@link #addAttributesExtractor(AttributesExtractor)} instead.
6264
*/
65+
@Deprecated
6366
@CanIgnoreReturnValue
6467
public GrpcTelemetryBuilder addAttributeExtractor(
6568
AttributesExtractor<? super GrpcRequest, ? super Status> attributesExtractor) {
6669
additionalExtractors.add(attributesExtractor);
6770
return this;
6871
}
6972

73+
/**
74+
* Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
75+
* items. The {@link AttributesExtractor} will be executed after all default extractors.
76+
*/
77+
@CanIgnoreReturnValue
78+
public GrpcTelemetryBuilder addAttributesExtractor(
79+
AttributesExtractor<? super GrpcRequest, ? super Status> attributesExtractor) {
80+
additionalExtractors.add(attributesExtractor);
81+
return this;
82+
}
83+
7084
/**
7185
* Adds an extra client-only {@link AttributesExtractor} to invoke to set attributes to
7286
* instrumented items. The {@link AttributesExtractor} will be executed after all default

‎instrumentation/grpc-1.6/library/src/test/java/io/opentelemetry/instrumentation/grpc/v1_6/GrpcTest.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ public void sayHello(
9191
.addService(greeter)
9292
.intercept(
9393
GrpcTelemetry.builder(testing.getOpenTelemetry())
94-
.addAttributeExtractor(new CustomAttributesExtractor())
94+
.addAttributesExtractor(new CustomAttributesExtractor())
9595
.addServerAttributeExtractor(new CustomAttributesExtractorV2("serverSideValue"))
9696
.build()
9797
.newServerInterceptor())
@@ -103,7 +103,7 @@ public void sayHello(
103103
ManagedChannelBuilder.forAddress("localhost", server.getPort())
104104
.intercept(
105105
GrpcTelemetry.builder(testing.getOpenTelemetry())
106-
.addAttributeExtractor(new CustomAttributesExtractor())
106+
.addAttributesExtractor(new CustomAttributesExtractor())
107107
.addClientAttributeExtractor(
108108
new CustomAttributesExtractorV2("clientSideValue"))
109109
.build()

‎instrumentation/java-http-client/library/src/main/java/io/opentelemetry/instrumentation/httpclient/JavaHttpClientTelemetryBuilder.java

+15-1
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,25 @@ public final class JavaHttpClientTelemetryBuilder {
3232
/**
3333
* Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
3434
* items. The {@link AttributesExtractor} will be executed after all default extractors.
35+
*
36+
* @deprecated Use {@link #addAttributesExtractor(AttributesExtractor)} instead.
3537
*/
38+
@Deprecated
3639
@CanIgnoreReturnValue
3740
public JavaHttpClientTelemetryBuilder addAttributeExtractor(
3841
AttributesExtractor<? super HttpRequest, ? super HttpResponse<?>> attributesExtractor) {
39-
builder.addAttributeExtractor(attributesExtractor);
42+
builder.addAttributesExtractor(attributesExtractor);
43+
return this;
44+
}
45+
46+
/**
47+
* Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
48+
* items. The {@link AttributesExtractor} will be executed after all default extractors.
49+
*/
50+
@CanIgnoreReturnValue
51+
public JavaHttpClientTelemetryBuilder addAttributesExtractor(
52+
AttributesExtractor<? super HttpRequest, ? super HttpResponse<?>> attributesExtractor) {
53+
builder.addAttributesExtractor(attributesExtractor);
4054
return this;
4155
}
4256

‎instrumentation/jetty-httpclient/jetty-httpclient-12.0/library/src/main/java/io/opentelemetry/instrumentation/jetty/httpclient/v12_0/JettyClientTelemetryBuilder.java

+15-1
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,25 @@ public JettyClientTelemetryBuilder setSslContextFactory(
4747
/**
4848
* Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
4949
* items.
50+
*
51+
* @deprecated Use {@link #addAttributesExtractor(AttributesExtractor)} instead.
5052
*/
53+
@Deprecated
5154
@CanIgnoreReturnValue
5255
public JettyClientTelemetryBuilder addAttributeExtractor(
5356
AttributesExtractor<? super Request, ? super Response> attributesExtractor) {
54-
builder.addAttributeExtractor(attributesExtractor);
57+
builder.addAttributesExtractor(attributesExtractor);
58+
return this;
59+
}
60+
61+
/**
62+
* Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
63+
* items.
64+
*/
65+
@CanIgnoreReturnValue
66+
public JettyClientTelemetryBuilder addAttributesExtractor(
67+
AttributesExtractor<? super Request, ? super Response> attributesExtractor) {
68+
builder.addAttributesExtractor(attributesExtractor);
5569
return this;
5670
}
5771

‎instrumentation/jetty-httpclient/jetty-httpclient-9.2/library/src/main/java/io/opentelemetry/instrumentation/jetty/httpclient/v9_2/JettyClientTelemetryBuilder.java

+15-1
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,25 @@ public JettyClientTelemetryBuilder setSslContextFactory(SslContextFactory sslCon
4747
/**
4848
* Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
4949
* items.
50+
*
51+
* @deprecated Use {@link #addAttributesExtractor(AttributesExtractor)} instead.
5052
*/
53+
@Deprecated
5154
@CanIgnoreReturnValue
5255
public JettyClientTelemetryBuilder addAttributeExtractor(
5356
AttributesExtractor<? super Request, ? super Response> attributesExtractor) {
54-
builder.addAttributeExtractor(attributesExtractor);
57+
builder.addAttributesExtractor(attributesExtractor);
58+
return this;
59+
}
60+
61+
/**
62+
* Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
63+
* items.
64+
*/
65+
@CanIgnoreReturnValue
66+
public JettyClientTelemetryBuilder addAttributesExtractor(
67+
AttributesExtractor<? super Request, ? super Response> attributesExtractor) {
68+
builder.addAttributesExtractor(attributesExtractor);
5569
return this;
5670
}
5771

‎instrumentation/ktor/ktor-2-common/library/src/main/kotlin/io/opentelemetry/instrumentation/ktor/client/AbstractKtorClientTracingBuilder.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ abstract class AbstractKtorClientTracingBuilder(
108108

109109
fun attributeExtractor(extractorBuilder: ExtractorBuilder.() -> Unit = {}) {
110110
val builder = ExtractorBuilder().apply(extractorBuilder).build()
111-
this.clientBuilder.addAttributeExtractor(
111+
this.clientBuilder.addAttributesExtractor(
112112
object : AttributesExtractor<HttpRequestData, HttpResponse> {
113113
override fun onStart(attributes: AttributesBuilder, parentContext: Context, request: HttpRequestData) {
114114
builder.onStart(OnStartData(attributes, parentContext, request))

‎instrumentation/netty/netty-4.1/library/src/main/java/io/opentelemetry/instrumentation/netty/v4_1/NettyClientTelemetryBuilder.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ public NettyClientTelemetryBuilder setCapturedResponseHeaders(
6969
@CanIgnoreReturnValue
7070
public NettyClientTelemetryBuilder addAttributesExtractor(
7171
AttributesExtractor<HttpRequestAndChannel, HttpResponse> attributesExtractor) {
72-
builder.addAttributeExtractor(attributesExtractor);
72+
builder.addAttributesExtractor(attributesExtractor);
7373
return this;
7474
}
7575

‎instrumentation/okhttp/okhttp-3.0/library/src/main/java/io/opentelemetry/instrumentation/okhttp/v3_0/OkHttpTelemetryBuilder.java

+15-1
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,25 @@ public final class OkHttpTelemetryBuilder {
3232
/**
3333
* Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
3434
* items.
35+
*
36+
* @deprecated Use {@link #addAttributesExtractor(AttributesExtractor)} instead.
3537
*/
38+
@Deprecated
3639
@CanIgnoreReturnValue
3740
public OkHttpTelemetryBuilder addAttributeExtractor(
3841
AttributesExtractor<? super Interceptor.Chain, ? super Response> attributesExtractor) {
39-
builder.addAttributeExtractor(attributesExtractor);
42+
builder.addAttributesExtractor(attributesExtractor);
43+
return this;
44+
}
45+
46+
/**
47+
* Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
48+
* items.
49+
*/
50+
@CanIgnoreReturnValue
51+
public OkHttpTelemetryBuilder addAttributesExtractor(
52+
AttributesExtractor<? super Interceptor.Chain, ? super Response> attributesExtractor) {
53+
builder.addAttributesExtractor(attributesExtractor);
4054
return this;
4155
}
4256

‎instrumentation/quartz-2.0/library/src/main/java/io/opentelemetry/instrumentation/quartz/v2_0/QuartzTelemetryBuilder.java

+14
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,28 @@ public final class QuartzTelemetryBuilder {
3838
/**
3939
* Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
4040
* items. The {@link AttributesExtractor} will be executed after all default extractors.
41+
*
42+
* @deprecated Use {@link #addAttributesExtractor(AttributesExtractor)} instead.
4143
*/
44+
@Deprecated
4245
@CanIgnoreReturnValue
4346
public QuartzTelemetryBuilder addAttributeExtractor(
4447
AttributesExtractor<? super JobExecutionContext, ? super Void> attributesExtractor) {
4548
additionalExtractors.add(attributesExtractor);
4649
return this;
4750
}
4851

52+
/**
53+
* Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
54+
* items. The {@link AttributesExtractor} will be executed after all default extractors.
55+
*/
56+
@CanIgnoreReturnValue
57+
public QuartzTelemetryBuilder addAttributesExtractor(
58+
AttributesExtractor<? super JobExecutionContext, ? super Void> attributesExtractor) {
59+
additionalExtractors.add(attributesExtractor);
60+
return this;
61+
}
62+
4963
/**
5064
* Sets whether experimental attributes should be set to spans. These attributes may be changed or
5165
* removed in the future, so only enable this if you know you do not require attributes filled by

‎instrumentation/r2dbc-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/r2dbc/v1_0/R2dbcSingletons.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public final class R2dbcSingletons {
2121
.getBoolean(
2222
"otel.instrumentation.r2dbc.statement-sanitizer.enabled",
2323
AgentCommonConfig.get().isStatementSanitizationEnabled()))
24-
.addAttributeExtractor(
24+
.addAttributesExtractor(
2525
PeerServiceAttributesExtractor.create(
2626
R2dbcNetAttributesGetter.INSTANCE,
2727
AgentCommonConfig.get().getPeerServiceResolver()))

‎instrumentation/r2dbc-1.0/library/src/main/java/io/opentelemetry/instrumentation/r2dbc/v1_0/R2dbcTelemetryBuilder.java

+12-1
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,21 @@ public final class R2dbcTelemetryBuilder {
2525
instrumenterBuilder = new R2dbcInstrumenterBuilder(openTelemetry);
2626
}
2727

28+
/**
29+
* @deprecated Use {@link #addAttributesExtractor(AttributesExtractor)} instead.
30+
*/
31+
@Deprecated
2832
@CanIgnoreReturnValue
2933
public R2dbcTelemetryBuilder addAttributeExtractor(
3034
AttributesExtractor<DbExecution, Void> attributesExtractor) {
31-
instrumenterBuilder.addAttributeExtractor(attributesExtractor);
35+
instrumenterBuilder.addAttributesExtractor(attributesExtractor);
36+
return this;
37+
}
38+
39+
@CanIgnoreReturnValue
40+
public R2dbcTelemetryBuilder addAttributesExtractor(
41+
AttributesExtractor<DbExecution, Void> attributesExtractor) {
42+
instrumenterBuilder.addAttributesExtractor(attributesExtractor);
3243
return this;
3344
}
3445

‎instrumentation/r2dbc-1.0/library/src/main/java/io/opentelemetry/instrumentation/r2dbc/v1_0/internal/R2dbcInstrumenterBuilder.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public R2dbcInstrumenterBuilder(OpenTelemetry openTelemetry) {
3737
}
3838

3939
@CanIgnoreReturnValue
40-
public R2dbcInstrumenterBuilder addAttributeExtractor(
40+
public R2dbcInstrumenterBuilder addAttributesExtractor(
4141
AttributesExtractor<DbExecution, Void> attributesExtractor) {
4242
additionalExtractors.add(attributesExtractor);
4343
return this;

‎instrumentation/ratpack/ratpack-1.7/library/src/main/java/io/opentelemetry/instrumentation/ratpack/v1_7/RatpackTelemetryBuilder.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public RatpackTelemetryBuilder addAttributeExtractor(
5252
@CanIgnoreReturnValue
5353
public RatpackTelemetryBuilder addClientAttributeExtractor(
5454
AttributesExtractor<? super RequestSpec, ? super HttpResponse> attributesExtractor) {
55-
clientBuilder.addAttributeExtractor(attributesExtractor);
55+
clientBuilder.addAttributesExtractor(attributesExtractor);
5656
return this;
5757
}
5858

‎instrumentation/spring/spring-web/spring-web-3.1/library/src/main/java/io/opentelemetry/instrumentation/spring/web/v3_1/SpringWebTelemetryBuilder.java

+15-1
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,25 @@ private DefaultHttpClientInstrumenterBuilder<HttpRequest, ClientHttpResponse> ge
4343
/**
4444
* Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
4545
* items.
46+
*
47+
* @deprecated Use {@link #addAttributesExtractor(AttributesExtractor)} instead.
4648
*/
49+
@Deprecated
4750
@CanIgnoreReturnValue
4851
public SpringWebTelemetryBuilder addAttributeExtractor(
4952
AttributesExtractor<? super HttpRequest, ? super ClientHttpResponse> attributesExtractor) {
50-
builder.addAttributeExtractor(attributesExtractor);
53+
builder.addAttributesExtractor(attributesExtractor);
54+
return this;
55+
}
56+
57+
/**
58+
* Adds an additional {@link AttributesExtractor} to invoke to set attributes to instrumented
59+
* items.
60+
*/
61+
@CanIgnoreReturnValue
62+
public SpringWebTelemetryBuilder addAttributesExtractor(
63+
AttributesExtractor<? super HttpRequest, ? super ClientHttpResponse> attributesExtractor) {
64+
builder.addAttributesExtractor(attributesExtractor);
5165
return this;
5266
}
5367

‎instrumentation/spring/spring-webflux/spring-webflux-5.3/library/src/main/java/io/opentelemetry/instrumentation/spring/webflux/v5_3/SpringWebfluxTelemetryBuilder.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ public final class SpringWebfluxTelemetryBuilder {
5858
@CanIgnoreReturnValue
5959
public SpringWebfluxTelemetryBuilder addClientAttributesExtractor(
6060
AttributesExtractor<ClientRequest, ClientResponse> attributesExtractor) {
61-
clientBuilder.addAttributeExtractor(attributesExtractor);
61+
clientBuilder.addAttributesExtractor(attributesExtractor);
6262
return this;
6363
}
6464

0 commit comments

Comments
 (0)