Skip to content

Commit 6b9e68e

Browse files
trasktrask
authored
Change setCaptured*Headers(List) to setCaptured*Headers(Collection) (#12901)
1 parent 5f135ba commit 6b9e68e

File tree

36 files changed

+235
-100
lines changed

36 files changed

+235
-100
lines changed

‎docs/apidiffs/current_vs_latest/opentelemetry-instrumentation-api.txt‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,11 @@
11
Comparing source compatibility of opentelemetry-instrumentation-api-2.12.0-SNAPSHOT.jar against opentelemetry-instrumentation-api-2.11.0.jar
2-
No changes.
2+
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.instrumentation.api.semconv.http.HttpClientAttributesExtractorBuilder (not serializable)
3+
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
4+
GENERIC TEMPLATES: === REQUEST:java.lang.Object, === RESPONSE:java.lang.Object
5+
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.instrumentation.api.semconv.http.HttpClientAttributesExtractorBuilder<REQUEST,RESPONSE> setCapturedRequestHeaders(java.util.Collection<java.lang.String>)
6+
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.instrumentation.api.semconv.http.HttpClientAttributesExtractorBuilder<REQUEST,RESPONSE> setCapturedResponseHeaders(java.util.Collection<java.lang.String>)
7+
*** MODIFIED CLASS: PUBLIC FINAL io.opentelemetry.instrumentation.api.semconv.http.HttpServerAttributesExtractorBuilder (not serializable)
8+
=== CLASS FILE FORMAT VERSION: 52.0 <- 52.0
9+
GENERIC TEMPLATES: === REQUEST:java.lang.Object, === RESPONSE:java.lang.Object
10+
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.instrumentation.api.semconv.http.HttpServerAttributesExtractorBuilder<REQUEST,RESPONSE> setCapturedRequestHeaders(java.util.Collection<java.lang.String>)
11+
+++ NEW METHOD: PUBLIC(+) io.opentelemetry.instrumentation.api.semconv.http.HttpServerAttributesExtractorBuilder<REQUEST,RESPONSE> setCapturedResponseHeaders(java.util.Collection<java.lang.String>)

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
import io.opentelemetry.instrumentation.api.semconv.http.HttpSpanNameExtractorBuilder;
2929
import io.opentelemetry.instrumentation.api.semconv.http.HttpSpanStatusExtractor;
3030
import java.util.ArrayList;
31+
import java.util.Collection;
3132
import java.util.List;
3233
import java.util.Objects;
3334
import java.util.Set;
@@ -126,7 +127,7 @@ public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> setStatusExtracto
126127
*/
127128
@CanIgnoreReturnValue
128129
public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> setCapturedRequestHeaders(
129-
List<String> requestHeaders) {
130+
Collection<String> requestHeaders) {
130131
httpAttributesExtractorBuilder.setCapturedRequestHeaders(requestHeaders);
131132
return this;
132133
}
@@ -138,7 +139,7 @@ public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> setCapturedReques
138139
*/
139140
@CanIgnoreReturnValue
140141
public DefaultHttpClientInstrumenterBuilder<REQUEST, RESPONSE> setCapturedResponseHeaders(
141-
List<String> responseHeaders) {
142+
Collection<String> responseHeaders) {
142143
httpAttributesExtractorBuilder.setCapturedResponseHeaders(responseHeaders);
143144
return this;
144145
}

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
import io.opentelemetry.instrumentation.api.semconv.http.HttpSpanNameExtractorBuilder;
2828
import io.opentelemetry.instrumentation.api.semconv.http.HttpSpanStatusExtractor;
2929
import java.util.ArrayList;
30+
import java.util.Collection;
3031
import java.util.List;
3132
import java.util.Objects;
3233
import java.util.Set;
@@ -124,7 +125,7 @@ public DefaultHttpServerInstrumenterBuilder<REQUEST, RESPONSE> setStatusExtracto
124125
*/
125126
@CanIgnoreReturnValue
126127
public DefaultHttpServerInstrumenterBuilder<REQUEST, RESPONSE> setCapturedRequestHeaders(
127-
List<String> requestHeaders) {
128+
Collection<String> requestHeaders) {
128129
httpAttributesExtractorBuilder.setCapturedRequestHeaders(requestHeaders);
129130
return this;
130131
}
@@ -136,7 +137,7 @@ public DefaultHttpServerInstrumenterBuilder<REQUEST, RESPONSE> setCapturedReques
136137
*/
137138
@CanIgnoreReturnValue
138139
public DefaultHttpServerInstrumenterBuilder<REQUEST, RESPONSE> setCapturedResponseHeaders(
139-
List<String> responseHeaders) {
140+
Collection<String> responseHeaders) {
140141
httpAttributesExtractorBuilder.setCapturedResponseHeaders(responseHeaders);
141142
return this;
142143
}

‎instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/messaging/MessagingAttributesExtractorBuilder.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99

1010
import com.google.errorprone.annotations.CanIgnoreReturnValue;
1111
import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
12+
import java.util.ArrayList;
13+
import java.util.Collection;
1214
import java.util.List;
1315

1416
/** A builder of {@link MessagingAttributesExtractor}. */
@@ -35,8 +37,8 @@ public final class MessagingAttributesExtractorBuilder<REQUEST, RESPONSE> {
3537
*/
3638
@CanIgnoreReturnValue
3739
public MessagingAttributesExtractorBuilder<REQUEST, RESPONSE> setCapturedHeaders(
38-
List<String> capturedHeaders) {
39-
this.capturedHeaders = capturedHeaders;
40+
Collection<String> capturedHeaders) {
41+
this.capturedHeaders = new ArrayList<>(capturedHeaders);
4042
return this;
4143
}
4244

‎instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/semconv/http/HttpClientAttributesExtractorBuilder.java‎

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
import io.opentelemetry.instrumentation.api.semconv.network.internal.InternalServerAttributesExtractor;
1818
import io.opentelemetry.instrumentation.api.semconv.network.internal.ServerAddressAndPortExtractor;
1919
import java.util.ArrayList;
20+
import java.util.Collection;
2021
import java.util.HashSet;
2122
import java.util.List;
2223
import java.util.Set;
@@ -57,11 +58,29 @@ public final class HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> {
5758
*/
5859
@CanIgnoreReturnValue
5960
public HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> setCapturedRequestHeaders(
60-
List<String> requestHeaders) {
61+
Collection<String> requestHeaders) {
6162
this.capturedRequestHeaders = new ArrayList<>(requestHeaders);
6263
return this;
6364
}
6465

66+
/**
67+
* Configures the HTTP request headers that will be captured as span attributes as described in <a
68+
* href="https://github.com/open-telemetry/semantic-conventions/blob/v1.23.0/docs/http/http-spans.md#http-client">HTTP
69+
* semantic conventions</a>.
70+
*
71+
* <p>The HTTP request header values will be captured under the {@code http.request.header.<key>}
72+
* attribute key. The {@code <key>} part in the attribute key is the lowercase header name.
73+
*
74+
* @param requestHeaders A list of HTTP header names.
75+
*/
76+
// don't deprecate this since users will get deprecation warning without a clean way to suppress
77+
// it if they're using List
78+
@CanIgnoreReturnValue
79+
public HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> setCapturedRequestHeaders(
80+
List<String> requestHeaders) {
81+
return setCapturedRequestHeaders((Collection<String>) requestHeaders);
82+
}
83+
6584
/**
6685
* Configures the HTTP response headers that will be captured as span attributes as described in
6786
* <a
@@ -76,11 +95,31 @@ public HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> setCapturedReques
7695
*/
7796
@CanIgnoreReturnValue
7897
public HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> setCapturedResponseHeaders(
79-
List<String> responseHeaders) {
98+
Collection<String> responseHeaders) {
8099
this.capturedResponseHeaders = new ArrayList<>(responseHeaders);
81100
return this;
82101
}
83102

103+
/**
104+
* Configures the HTTP response headers that will be captured as span attributes as described in
105+
* <a
106+
* href="https://github.com/open-telemetry/semantic-conventions/blob/v1.23.0/docs/http/http-spans.md#common-attributes">HTTP
107+
* semantic conventions</a>.
108+
*
109+
* <p>The HTTP response header values will be captured under the {@code
110+
* http.response.header.<key>} attribute key. The {@code <key>} part in the attribute key is the
111+
* lowercase header name.
112+
*
113+
* @param responseHeaders A list of HTTP header names.
114+
*/
115+
// don't deprecate this since users will get deprecation warning without a clean way to suppress
116+
// it if they're using List
117+
@CanIgnoreReturnValue
118+
public HttpClientAttributesExtractorBuilder<REQUEST, RESPONSE> setCapturedResponseHeaders(
119+
List<String> responseHeaders) {
120+
return setCapturedResponseHeaders((Collection<String>) responseHeaders);
121+
}
122+
84123
/**
85124
* Configures the extractor to recognize an alternative set of HTTP request methods.
86125
*

‎instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/semconv/http/HttpServerAttributesExtractorBuilder.java‎

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
import io.opentelemetry.instrumentation.api.semconv.network.internal.InternalServerAttributesExtractor;
2020
import io.opentelemetry.instrumentation.api.semconv.url.internal.InternalUrlAttributesExtractor;
2121
import java.util.ArrayList;
22+
import java.util.Collection;
2223
import java.util.HashSet;
2324
import java.util.List;
2425
import java.util.Set;
@@ -63,11 +64,30 @@ public final class HttpServerAttributesExtractorBuilder<REQUEST, RESPONSE> {
6364
*/
6465
@CanIgnoreReturnValue
6566
public HttpServerAttributesExtractorBuilder<REQUEST, RESPONSE> setCapturedRequestHeaders(
66-
List<String> requestHeaders) {
67+
Collection<String> requestHeaders) {
6768
this.capturedRequestHeaders = new ArrayList<>(requestHeaders);
6869
return this;
6970
}
7071

72+
/**
73+
* Configures the HTTP response headers that will be captured as span attributes as described in
74+
* <a
75+
* href="https://github.com/open-telemetry/semantic-conventions/blob/v1.23.0/docs/http/http-spans.md#http-server-semantic-conventions">HTTP
76+
* semantic conventions</a>.
77+
*
78+
* <p>The HTTP request header values will be captured under the {@code http.request.header.<key>}
79+
* attribute key. The {@code <key>} part in the attribute key is the lowercase header name.
80+
*
81+
* @param requestHeaders A list of HTTP header names.
82+
*/
83+
// don't deprecate this since users will get deprecation warning without a clean way to suppress
84+
// it if they're using List
85+
@CanIgnoreReturnValue
86+
public HttpServerAttributesExtractorBuilder<REQUEST, RESPONSE> setCapturedRequestHeaders(
87+
List<String> requestHeaders) {
88+
return setCapturedRequestHeaders((Collection<String>) requestHeaders);
89+
}
90+
7191
/**
7292
* Configures the HTTP response headers that will be captured as span attributes as described in
7393
* <a
@@ -82,11 +102,31 @@ public HttpServerAttributesExtractorBuilder<REQUEST, RESPONSE> setCapturedReques
82102
*/
83103
@CanIgnoreReturnValue
84104
public HttpServerAttributesExtractorBuilder<REQUEST, RESPONSE> setCapturedResponseHeaders(
85-
List<String> responseHeaders) {
105+
Collection<String> responseHeaders) {
86106
this.capturedResponseHeaders = new ArrayList<>(responseHeaders);
87107
return this;
88108
}
89109

110+
/**
111+
* Configures the HTTP response headers that will be captured as span attributes as described in
112+
* <a
113+
* href="https://github.com/open-telemetry/semantic-conventions/blob/v1.23.0/docs/http/http-spans.md#common-attributes">HTTP
114+
* semantic conventions</a>.
115+
*
116+
* <p>The HTTP response header values will be captured under the {@code
117+
* http.response.header.<key>} attribute key. The {@code <key>} part in the attribute key is the
118+
* lowercase header name.
119+
*
120+
* @param responseHeaders A list of HTTP header names.
121+
*/
122+
// don't deprecate this since users will get deprecation warning without a clean way to suppress
123+
// it if they're using List
124+
@CanIgnoreReturnValue
125+
public HttpServerAttributesExtractorBuilder<REQUEST, RESPONSE> setCapturedResponseHeaders(
126+
List<String> responseHeaders) {
127+
return setCapturedResponseHeaders((Collection<String>) responseHeaders);
128+
}
129+
90130
/**
91131
* Configures the extractor to recognize an alternative set of HTTP request methods.
92132
*

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
1313
import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor;
1414
import io.opentelemetry.instrumentation.api.semconv.http.HttpClientAttributesExtractorBuilder;
15-
import java.util.List;
15+
import java.util.Collection;
1616
import java.util.Set;
1717
import java.util.function.Function;
1818
import org.apache.http.HttpResponse;
@@ -69,7 +69,8 @@ public ApacheHttpClientTelemetryBuilder addAttributesExtractor(
6969
* @param requestHeaders A list of HTTP header names.
7070
*/
7171
@CanIgnoreReturnValue
72-
public ApacheHttpClientTelemetryBuilder setCapturedRequestHeaders(List<String> requestHeaders) {
72+
public ApacheHttpClientTelemetryBuilder setCapturedRequestHeaders(
73+
Collection<String> requestHeaders) {
7374
builder.setCapturedRequestHeaders(requestHeaders);
7475
return this;
7576
}
@@ -80,7 +81,8 @@ public ApacheHttpClientTelemetryBuilder setCapturedRequestHeaders(List<String> r
8081
* @param responseHeaders A list of HTTP header names.
8182
*/
8283
@CanIgnoreReturnValue
83-
public ApacheHttpClientTelemetryBuilder setCapturedResponseHeaders(List<String> responseHeaders) {
84+
public ApacheHttpClientTelemetryBuilder setCapturedResponseHeaders(
85+
Collection<String> responseHeaders) {
8486
builder.setCapturedResponseHeaders(responseHeaders);
8587
return this;
8688
}

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
1313
import io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor;
1414
import io.opentelemetry.instrumentation.api.semconv.http.HttpClientAttributesExtractorBuilder;
15-
import java.util.List;
15+
import java.util.Collection;
1616
import java.util.Set;
1717
import java.util.function.Function;
1818
import org.apache.hc.core5.http.HttpResponse;
@@ -54,7 +54,8 @@ public ApacheHttpClientTelemetryBuilder addAttributesExtractor(
5454
* @param requestHeaders A list of HTTP header names.
5555
*/
5656
@CanIgnoreReturnValue
57-
public ApacheHttpClientTelemetryBuilder setCapturedRequestHeaders(List<String> requestHeaders) {
57+
public ApacheHttpClientTelemetryBuilder setCapturedRequestHeaders(
58+
Collection<String> requestHeaders) {
5859
builder.setCapturedRequestHeaders(requestHeaders);
5960
return this;
6061
}
@@ -65,7 +66,8 @@ public ApacheHttpClientTelemetryBuilder setCapturedRequestHeaders(List<String> r
6566
* @param responseHeaders A list of HTTP header names.
6667
*/
6768
@CanIgnoreReturnValue
68-
public ApacheHttpClientTelemetryBuilder setCapturedResponseHeaders(List<String> responseHeaders) {
69+
public ApacheHttpClientTelemetryBuilder setCapturedResponseHeaders(
70+
Collection<String> responseHeaders) {
6971
builder.setCapturedResponseHeaders(responseHeaders);
7072
return this;
7173
}

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
import io.opentelemetry.instrumentation.armeria.v1_3.internal.ArmeriaInstrumenterBuilderFactory;
1818
import io.opentelemetry.instrumentation.armeria.v1_3.internal.ArmeriaInstrumenterBuilderUtil;
1919
import io.opentelemetry.instrumentation.armeria.v1_3.internal.Experimental;
20-
import java.util.List;
20+
import java.util.Collection;
2121
import java.util.Set;
2222
import java.util.function.Function;
2323

@@ -65,7 +65,8 @@ public ArmeriaClientTelemetryBuilder addAttributesExtractor(
6565
* @param requestHeaders A list of HTTP header names.
6666
*/
6767
@CanIgnoreReturnValue
68-
public ArmeriaClientTelemetryBuilder setCapturedRequestHeaders(List<String> requestHeaders) {
68+
public ArmeriaClientTelemetryBuilder setCapturedRequestHeaders(
69+
Collection<String> requestHeaders) {
6970
builder.setCapturedRequestHeaders(requestHeaders);
7071
return this;
7172
}
@@ -76,7 +77,8 @@ public ArmeriaClientTelemetryBuilder setCapturedRequestHeaders(List<String> requ
7677
* @param responseHeaders A list of HTTP header names.
7778
*/
7879
@CanIgnoreReturnValue
79-
public ArmeriaClientTelemetryBuilder setCapturedResponseHeaders(List<String> responseHeaders) {
80+
public ArmeriaClientTelemetryBuilder setCapturedResponseHeaders(
81+
Collection<String> responseHeaders) {
8082
builder.setCapturedResponseHeaders(responseHeaders);
8183
return this;
8284
}

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
import io.opentelemetry.instrumentation.armeria.v1_3.internal.ArmeriaInstrumenterBuilderFactory;
1818
import io.opentelemetry.instrumentation.armeria.v1_3.internal.ArmeriaInstrumenterBuilderUtil;
1919
import io.opentelemetry.instrumentation.armeria.v1_3.internal.Experimental;
20-
import java.util.List;
20+
import java.util.Collection;
2121
import java.util.Set;
2222
import java.util.function.Function;
2323

@@ -63,7 +63,8 @@ public ArmeriaServerTelemetryBuilder addAttributesExtractor(
6363
* @param requestHeaders A list of HTTP header names.
6464
*/
6565
@CanIgnoreReturnValue
66-
public ArmeriaServerTelemetryBuilder setCapturedRequestHeaders(List<String> requestHeaders) {
66+
public ArmeriaServerTelemetryBuilder setCapturedRequestHeaders(
67+
Collection<String> requestHeaders) {
6768
builder.setCapturedRequestHeaders(requestHeaders);
6869
return this;
6970
}
@@ -74,7 +75,8 @@ public ArmeriaServerTelemetryBuilder setCapturedRequestHeaders(List<String> requ
7475
* @param responseHeaders A list of HTTP header names.
7576
*/
7677
@CanIgnoreReturnValue
77-
public ArmeriaServerTelemetryBuilder setCapturedResponseHeaders(List<String> responseHeaders) {
78+
public ArmeriaServerTelemetryBuilder setCapturedResponseHeaders(
79+
Collection<String> responseHeaders) {
7880
builder.setCapturedResponseHeaders(responseHeaders);
7981
return this;
8082
}

0 commit comments

Comments
 (0)