Skip to content

Commit 7e35f0c

Browse files
breedx-splkbreedx-splk
authored
Remove deprecated config properties (#10349)
1 parent 2a67c7e commit 7e35f0c

File tree

9 files changed

+52
-76
lines changed

9 files changed

+52
-76
lines changed

‎CHANGELOG.md

+18
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,24 @@
22

33
## Unreleased
44

5+
- Remove deprecated config properties in favor of the new names (#10349):
6+
- `otel.instrumentation.kafka.client-propagation.enabled` ->
7+
`otel.instrumentation.kafka.producer-propagation.enabled`
8+
- `otel.instrumentation.netty.always-create-connect-span` ->
9+
`otel.instrumentation.netty.connection-telemetry.enabled`
10+
- `otel.instrumentation.http.capture-headers.client.request` ->
11+
`otel.instrumentation.http.client.capture-request-headers`
12+
- `otel.instrumentation.http.capture-headers.client.response` ->
13+
`otel.instrumentation.http.client.capture-response-headers`
14+
- `otel.instrumentation.http.capture-headers.server.request` ->
15+
`otel.instrumentation.http.server.capture-request-headers`
16+
- `otel.instrumentation.http.capture-headers.server.response` ->
17+
`otel.instrumentation.http.server.capture-response-headers`
18+
- `otel.instrumentation.http.client.emit-experimental-metrics` ->
19+
`otel.instrumentation.http.client.emit-experimental-telemetry`
20+
- `otel.instrumentation.http.server.emit-experimental-metrics` ->
21+
`otel.instrumentation.http.server.emit-experimental-telemetry`
22+
523
## Version 2.0.0 (2024-01-12)
624

725
The 2.0.0 release contains significant breaking changes that will most likely affect all users,

‎instrumentation/kafka/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
| System property | Type | Default | Description |
44
|-----------------------------------------------------------| ------- |---------|--------------------------------------------------------------------------------------------------------------------------------|
55
| `otel.instrumentation.kafka.experimental-span-attributes` | Boolean | `false` | Enable the capture of experimental span attributes. |
6-
| `otel.instrumentation.kafka.client-propagation.enabled` | Boolean | `true` | Enable context propagation for kafka message producer. |
6+
| `otel.instrumentation.kafka.producer-propagation.enabled` | Boolean | `true` | Enable context propagation for kafka message producer. |
77
| `otel.instrumentation.kafka.metric-reporter.enabled` | Boolean | `true` | Enable kafka consumer and producer metrics. **Deprecated**, disable instrumentation with name `kafka-clients-metrics` instead. |

‎instrumentation/kafka/kafka-clients/kafka-clients-0.11/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/kafkaclients/v0_11/KafkaSingletons.java

+2-6
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
import io.opentelemetry.instrumentation.kafka.internal.KafkaProcessRequest;
1212
import io.opentelemetry.instrumentation.kafka.internal.KafkaProducerRequest;
1313
import io.opentelemetry.instrumentation.kafka.internal.KafkaReceiveRequest;
14-
import io.opentelemetry.javaagent.bootstrap.internal.DeprecatedConfigProperties;
1514
import io.opentelemetry.javaagent.bootstrap.internal.ExperimentalConfig;
1615
import io.opentelemetry.javaagent.bootstrap.internal.InstrumentationConfig;
1716
import org.apache.kafka.clients.producer.RecordMetadata;
@@ -20,11 +19,8 @@ public final class KafkaSingletons {
2019
private static final String INSTRUMENTATION_NAME = "io.opentelemetry.kafka-clients-0.11";
2120

2221
private static final boolean PRODUCER_PROPAGATION_ENABLED =
23-
DeprecatedConfigProperties.getBoolean(
24-
InstrumentationConfig.get(),
25-
"otel.instrumentation.kafka.client-propagation.enabled",
26-
"otel.instrumentation.kafka.producer-propagation.enabled",
27-
true);
22+
InstrumentationConfig.get()
23+
.getBoolean("otel.instrumentation.kafka.producer-propagation.enabled", true);
2824

2925
private static final Instrumenter<KafkaProducerRequest, RecordMetadata> PRODUCER_INSTRUMENTER;
3026
private static final Instrumenter<KafkaReceiveRequest, Void> CONSUMER_RECEIVE_INSTRUMENTER;

‎instrumentation/netty/netty-4.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/netty/v4_0/client/NettyClientSingletons.java

+6-15
Original file line numberDiff line numberDiff line change
@@ -15,26 +15,17 @@
1515
import io.opentelemetry.instrumentation.netty.v4.common.internal.client.NettyConnectionInstrumenter;
1616
import io.opentelemetry.instrumentation.netty.v4.common.internal.client.NettySslInstrumenter;
1717
import io.opentelemetry.javaagent.bootstrap.internal.CommonConfig;
18-
import io.opentelemetry.javaagent.bootstrap.internal.DeprecatedConfigProperties;
1918
import io.opentelemetry.javaagent.bootstrap.internal.InstrumentationConfig;
2019
import java.util.Collections;
2120

2221
public final class NettyClientSingletons {
2322

24-
private static final boolean connectionTelemetryEnabled;
25-
private static final boolean sslTelemetryEnabled;
26-
27-
static {
28-
InstrumentationConfig config = InstrumentationConfig.get();
29-
connectionTelemetryEnabled =
30-
DeprecatedConfigProperties.getBoolean(
31-
config,
32-
"otel.instrumentation.netty.always-create-connect-span",
33-
"otel.instrumentation.netty.connection-telemetry.enabled",
34-
false);
35-
sslTelemetryEnabled =
36-
config.getBoolean("otel.instrumentation.netty.ssl-telemetry.enabled", false);
37-
}
23+
private static final boolean connectionTelemetryEnabled =
24+
InstrumentationConfig.get()
25+
.getBoolean("otel.instrumentation.netty.connection-telemetry.enabled", false);
26+
private static final boolean sslTelemetryEnabled =
27+
InstrumentationConfig.get()
28+
.getBoolean("otel.instrumentation.netty.ssl-telemetry.enabled", false);
3829

3930
private static final Instrumenter<HttpRequestAndChannel, HttpResponse> INSTRUMENTER;
4031
private static final NettyConnectionInstrumenter CONNECTION_INSTRUMENTER;

‎instrumentation/netty/netty-4.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/netty/v4_1/NettyClientSingletons.java

+6-15
Original file line numberDiff line numberDiff line change
@@ -15,26 +15,17 @@
1515
import io.opentelemetry.instrumentation.netty.v4.common.internal.client.NettyConnectionInstrumenter;
1616
import io.opentelemetry.instrumentation.netty.v4.common.internal.client.NettySslInstrumenter;
1717
import io.opentelemetry.javaagent.bootstrap.internal.CommonConfig;
18-
import io.opentelemetry.javaagent.bootstrap.internal.DeprecatedConfigProperties;
1918
import io.opentelemetry.javaagent.bootstrap.internal.InstrumentationConfig;
2019
import java.util.Collections;
2120

2221
public final class NettyClientSingletons {
2322

24-
private static final boolean connectionTelemetryEnabled;
25-
private static final boolean sslTelemetryEnabled;
26-
27-
static {
28-
InstrumentationConfig config = InstrumentationConfig.get();
29-
connectionTelemetryEnabled =
30-
DeprecatedConfigProperties.getBoolean(
31-
config,
32-
"otel.instrumentation.netty.always-create-connect-span",
33-
"otel.instrumentation.netty.connection-telemetry.enabled",
34-
false);
35-
sslTelemetryEnabled =
36-
config.getBoolean("otel.instrumentation.netty.ssl-telemetry.enabled", false);
37-
}
23+
private static final boolean connectionTelemetryEnabled =
24+
InstrumentationConfig.get()
25+
.getBoolean("otel.instrumentation.netty.connection-telemetry.enabled", false);
26+
private static final boolean sslTelemetryEnabled =
27+
InstrumentationConfig.get()
28+
.getBoolean("otel.instrumentation.netty.ssl-telemetry.enabled", false);
3829

3930
private static final Instrumenter<HttpRequestAndChannel, HttpResponse> INSTRUMENTER;
4031
private static final NettyConnectionInstrumenter CONNECTION_INSTRUMENTER;

‎instrumentation/reactor/reactor-netty/reactor-netty-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/reactornetty/v1_0/ReactorNettySingletons.java

+3-12
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
import io.opentelemetry.instrumentation.netty.v4.common.internal.client.NettyConnectionInstrumentationFlag;
2020
import io.opentelemetry.instrumentation.netty.v4.common.internal.client.NettyConnectionInstrumenter;
2121
import io.opentelemetry.javaagent.bootstrap.internal.CommonConfig;
22-
import io.opentelemetry.javaagent.bootstrap.internal.DeprecatedConfigProperties;
2322
import io.opentelemetry.javaagent.bootstrap.internal.InstrumentationConfig;
2423
import reactor.netty.http.client.HttpClientRequest;
2524
import reactor.netty.http.client.HttpClientResponse;
@@ -28,17 +27,9 @@ public final class ReactorNettySingletons {
2827

2928
private static final String INSTRUMENTATION_NAME = "io.opentelemetry.reactor-netty-1.0";
3029

31-
private static final boolean connectionTelemetryEnabled;
32-
33-
static {
34-
InstrumentationConfig config = InstrumentationConfig.get();
35-
connectionTelemetryEnabled =
36-
DeprecatedConfigProperties.getBoolean(
37-
config,
38-
"otel.instrumentation.reactor-netty.always-create-connect-span",
39-
"otel.instrumentation.reactor-netty.connection-telemetry.enabled",
40-
false);
41-
}
30+
private static final boolean connectionTelemetryEnabled =
31+
InstrumentationConfig.get()
32+
.getBoolean("otel.instrumentation.reactor-netty.connection-telemetry.enabled", false);
4233

4334
private static final Instrumenter<HttpClientRequest, HttpClientResponse> INSTRUMENTER;
4435
private static final NettyConnectionInstrumenter CONNECTION_INSTRUMENTER;

‎javaagent-extension-api/src/main/java/io/opentelemetry/javaagent/bootstrap/internal/CommonConfig.java

+6-27
Original file line numberDiff line numberDiff line change
@@ -42,27 +42,14 @@ public static CommonConfig get() {
4242
PeerServiceResolver.create(
4343
config.getMap("otel.instrumentation.common.peer-service-mapping", emptyMap()));
4444

45-
// TODO (mateusz): remove the old config names in 2.0
4645
clientRequestHeaders =
47-
DeprecatedConfigProperties.getList(
48-
config,
49-
"otel.instrumentation.http.capture-headers.client.request",
50-
"otel.instrumentation.http.client.capture-request-headers");
46+
config.getList("otel.instrumentation.http.client.capture-request-headers");
5147
clientResponseHeaders =
52-
DeprecatedConfigProperties.getList(
53-
config,
54-
"otel.instrumentation.http.capture-headers.client.response",
55-
"otel.instrumentation.http.client.capture-response-headers");
48+
config.getList("otel.instrumentation.http.client.capture-response-headers");
5649
serverRequestHeaders =
57-
DeprecatedConfigProperties.getList(
58-
config,
59-
"otel.instrumentation.http.capture-headers.server.request",
60-
"otel.instrumentation.http.server.capture-request-headers");
50+
config.getList("otel.instrumentation.http.server.capture-request-headers");
6151
serverResponseHeaders =
62-
DeprecatedConfigProperties.getList(
63-
config,
64-
"otel.instrumentation.http.capture-headers.server.response",
65-
"otel.instrumentation.http.server.capture-response-headers");
52+
config.getList("otel.instrumentation.http.server.capture-response-headers");
6653
knownHttpRequestMethods =
6754
new HashSet<>(
6855
config.getList(
@@ -71,17 +58,9 @@ public static CommonConfig get() {
7158
statementSanitizationEnabled =
7259
config.getBoolean("otel.instrumentation.common.db-statement-sanitizer.enabled", true);
7360
emitExperimentalHttpClientTelemetry =
74-
DeprecatedConfigProperties.getBoolean(
75-
config,
76-
"otel.instrumentation.http.client.emit-experimental-metrics",
77-
"otel.instrumentation.http.client.emit-experimental-telemetry",
78-
false);
61+
config.getBoolean("otel.instrumentation.http.client.emit-experimental-telemetry", false);
7962
emitExperimentalHttpServerTelemetry =
80-
DeprecatedConfigProperties.getBoolean(
81-
config,
82-
"otel.instrumentation.http.server.emit-experimental-metrics",
83-
"otel.instrumentation.http.server.emit-experimental-telemetry",
84-
false);
63+
config.getBoolean("otel.instrumentation.http.server.emit-experimental-telemetry", false);
8564
enduserConfig = new EnduserConfig(config);
8665
}
8766

‎javaagent-extension-api/src/main/java/io/opentelemetry/javaagent/bootstrap/internal/DeprecatedConfigProperties.java

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
* This class is internal and is hence not for public use. Its APIs are unstable and can change at
1616
* any time.
1717
*/
18+
@SuppressWarnings("unused")
1819
public final class DeprecatedConfigProperties {
1920

2021
private static final Logger logger = Logger.getLogger(DeprecatedConfigProperties.class.getName());

‎javaagent-extension-api/src/main/java/io/opentelemetry/javaagent/bootstrap/internal/InstrumentationConfig.java

+9
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
package io.opentelemetry.javaagent.bootstrap.internal;
77

8+
import static java.util.Collections.emptyList;
89
import static java.util.Objects.requireNonNull;
910

1011
import java.time.Duration;
@@ -114,6 +115,14 @@ public static InstrumentationConfig get() {
114115
*/
115116
public abstract Duration getDuration(String name, Duration defaultValue);
116117

118+
/**
119+
* This is the same as calling {@code getList(String, List)} with the defaultValue equal to the
120+
* emptyList()/
121+
*/
122+
public List<String> getList(String name) {
123+
return getList(name, emptyList());
124+
}
125+
117126
/**
118127
* Returns a list-valued configuration property or {@code defaultValue} if a property with name
119128
* {@code name} has not been configured. The format of the original value must be comma-separated,

0 commit comments

Comments
 (0)