Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove deprecated config properties #10349

Merged
merged 5 commits into from
Jan 31, 2024
Merged

Remove deprecated config properties #10349

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1d176a8
remove deprecated config properties now that 2.0.0 is out
breedx-splk Jan 29, 2024
f4ddc21
update changelog
breedx-splk Jan 29, 2024
5753d56
remove stray
breedx-splk Jan 29, 2024
b04838c
restore handy utility class that may or may not be used.
breedx-splk Jan 30, 2024
fd2f582
update property name
breedx-splk Jan 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,24 @@

## Unreleased

- Remove deprecated config properties in favor of the new names (#10349):
- `otel.instrumentation.kafka.client-propagation.enabled` ->
`otel.instrumentation.kafka.producer-propagation.enabled`
- `otel.instrumentation.netty.always-create-connect-span` ->
`otel.instrumentation.netty.connection-telemetry.enabled`
- `otel.instrumentation.http.capture-headers.client.request` ->
`otel.instrumentation.http.client.capture-request-headers`
- `otel.instrumentation.http.capture-headers.client.response` ->
`otel.instrumentation.http.client.capture-response-headers`
- `otel.instrumentation.http.capture-headers.server.request` ->
`otel.instrumentation.http.server.capture-request-headers`
- `otel.instrumentation.http.capture-headers.server.response` ->
`otel.instrumentation.http.server.capture-response-headers`
- `otel.instrumentation.http.client.emit-experimental-metrics` ->
`otel.instrumentation.http.client.emit-experimental-telemetry`
- `otel.instrumentation.http.server.emit-experimental-metrics` ->
`otel.instrumentation.http.server.emit-experimental-telemetry`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️


## Version 2.0.0 (2024-01-12)

The 2.0.0 release contains significant breaking changes that will most likely affect all users,
Expand Down
8 changes: 2 additions & 6 deletions ...n/java/io/opentelemetry/javaagent/instrumentation/kafkaclients/v0_11/KafkaSingletons.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
import io.opentelemetry.instrumentation.kafka.internal.KafkaProcessRequest;
import io.opentelemetry.instrumentation.kafka.internal.KafkaProducerRequest;
import io.opentelemetry.instrumentation.kafka.internal.KafkaReceiveRequest;
import io.opentelemetry.javaagent.bootstrap.internal.DeprecatedConfigProperties;
import io.opentelemetry.javaagent.bootstrap.internal.ExperimentalConfig;
import io.opentelemetry.javaagent.bootstrap.internal.InstrumentationConfig;
import org.apache.kafka.clients.producer.RecordMetadata;
Expand All @@ -20,11 +19,8 @@ public final class KafkaSingletons {
private static final String INSTRUMENTATION_NAME = "io.opentelemetry.kafka-clients-0.11";

private static final boolean PRODUCER_PROPAGATION_ENABLED =
DeprecatedConfigProperties.getBoolean(
InstrumentationConfig.get(),
"otel.instrumentation.kafka.client-propagation.enabled",
"otel.instrumentation.kafka.producer-propagation.enabled",
true);
InstrumentationConfig.get()
.getBoolean("otel.instrumentation.kafka.producer-propagation.enabled", true);

private static final Instrumenter<KafkaProducerRequest, RecordMetadata> PRODUCER_INSTRUMENTER;
private static final Instrumenter<KafkaReceiveRequest, Void> CONSUMER_RECEIVE_INSTRUMENTER;
Expand Down
21 changes: 6 additions & 15 deletions ...a/io/opentelemetry/javaagent/instrumentation/netty/v4_0/client/NettyClientSingletons.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,26 +15,17 @@
import io.opentelemetry.instrumentation.netty.v4.common.internal.client.NettyConnectionInstrumenter;
import io.opentelemetry.instrumentation.netty.v4.common.internal.client.NettySslInstrumenter;
import io.opentelemetry.javaagent.bootstrap.internal.CommonConfig;
import io.opentelemetry.javaagent.bootstrap.internal.DeprecatedConfigProperties;
import io.opentelemetry.javaagent.bootstrap.internal.InstrumentationConfig;
import java.util.Collections;

public final class NettyClientSingletons {

private static final boolean connectionTelemetryEnabled;
private static final boolean sslTelemetryEnabled;

static {
InstrumentationConfig config = InstrumentationConfig.get();
connectionTelemetryEnabled =
DeprecatedConfigProperties.getBoolean(
config,
"otel.instrumentation.netty.always-create-connect-span",
"otel.instrumentation.netty.connection-telemetry.enabled",
false);
sslTelemetryEnabled =
config.getBoolean("otel.instrumentation.netty.ssl-telemetry.enabled", false);
}
private static final boolean connectionTelemetryEnabled =
InstrumentationConfig.get()
.getBoolean("otel.instrumentation.netty.connection-telemetry.enabled", false);
private static final boolean sslTelemetryEnabled =
InstrumentationConfig.get()
.getBoolean("otel.instrumentation.netty.ssl-telemetry.enabled", false);

private static final Instrumenter<HttpRequestAndChannel, HttpResponse> INSTRUMENTER;
private static final NettyConnectionInstrumenter CONNECTION_INSTRUMENTER;
Expand Down
21 changes: 6 additions & 15 deletions ...ain/java/io/opentelemetry/javaagent/instrumentation/netty/v4_1/NettyClientSingletons.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,26 +15,17 @@
import io.opentelemetry.instrumentation.netty.v4.common.internal.client.NettyConnectionInstrumenter;
import io.opentelemetry.instrumentation.netty.v4.common.internal.client.NettySslInstrumenter;
import io.opentelemetry.javaagent.bootstrap.internal.CommonConfig;
import io.opentelemetry.javaagent.bootstrap.internal.DeprecatedConfigProperties;
import io.opentelemetry.javaagent.bootstrap.internal.InstrumentationConfig;
import java.util.Collections;

public final class NettyClientSingletons {

private static final boolean connectionTelemetryEnabled;
private static final boolean sslTelemetryEnabled;

static {
InstrumentationConfig config = InstrumentationConfig.get();
connectionTelemetryEnabled =
DeprecatedConfigProperties.getBoolean(
config,
"otel.instrumentation.netty.always-create-connect-span",
"otel.instrumentation.netty.connection-telemetry.enabled",
false);
sslTelemetryEnabled =
config.getBoolean("otel.instrumentation.netty.ssl-telemetry.enabled", false);
}
private static final boolean connectionTelemetryEnabled =
InstrumentationConfig.get()
.getBoolean("otel.instrumentation.netty.connection-telemetry.enabled", false);
private static final boolean sslTelemetryEnabled =
InstrumentationConfig.get()
.getBoolean("otel.instrumentation.netty.ssl-telemetry.enabled", false);

private static final Instrumenter<HttpRequestAndChannel, HttpResponse> INSTRUMENTER;
private static final NettyConnectionInstrumenter CONNECTION_INSTRUMENTER;
Expand Down
15 changes: 3 additions & 12 deletions .../io/opentelemetry/javaagent/instrumentation/reactornetty/v1_0/ReactorNettySingletons.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
import io.opentelemetry.instrumentation.netty.v4.common.internal.client.NettyConnectionInstrumentationFlag;
import io.opentelemetry.instrumentation.netty.v4.common.internal.client.NettyConnectionInstrumenter;
import io.opentelemetry.javaagent.bootstrap.internal.CommonConfig;
import io.opentelemetry.javaagent.bootstrap.internal.DeprecatedConfigProperties;
import io.opentelemetry.javaagent.bootstrap.internal.InstrumentationConfig;
import reactor.netty.http.client.HttpClientRequest;
import reactor.netty.http.client.HttpClientResponse;
Expand All @@ -28,17 +27,9 @@ public final class ReactorNettySingletons {

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

private static final boolean connectionTelemetryEnabled;

static {
InstrumentationConfig config = InstrumentationConfig.get();
connectionTelemetryEnabled =
DeprecatedConfigProperties.getBoolean(
config,
"otel.instrumentation.reactor-netty.always-create-connect-span",
"otel.instrumentation.reactor-netty.connection-telemetry.enabled",
false);
}
private static final boolean connectionTelemetryEnabled =
InstrumentationConfig.get()
.getBoolean("otel.instrumentation.reactor-netty.connection-telemetry.enabled", false);

private static final Instrumenter<HttpClientRequest, HttpClientResponse> INSTRUMENTER;
private static final NettyConnectionInstrumenter CONNECTION_INSTRUMENTER;
Expand Down
33 changes: 6 additions & 27 deletions ...tension-api/src/main/java/io/opentelemetry/javaagent/bootstrap/internal/CommonConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,27 +42,14 @@ public static CommonConfig get() {
PeerServiceResolver.create(
config.getMap("otel.instrumentation.common.peer-service-mapping", emptyMap()));

// TODO (mateusz): remove the old config names in 2.0
clientRequestHeaders =
DeprecatedConfigProperties.getList(
config,
"otel.instrumentation.http.capture-headers.client.request",
"otel.instrumentation.http.client.capture-request-headers");
config.getList("otel.instrumentation.http.client.capture-request-headers");
clientResponseHeaders =
DeprecatedConfigProperties.getList(
config,
"otel.instrumentation.http.capture-headers.client.response",
"otel.instrumentation.http.client.capture-response-headers");
config.getList("otel.instrumentation.http.client.capture-response-headers");
serverRequestHeaders =
DeprecatedConfigProperties.getList(
config,
"otel.instrumentation.http.capture-headers.server.request",
"otel.instrumentation.http.server.capture-request-headers");
config.getList("otel.instrumentation.http.server.capture-request-headers");
serverResponseHeaders =
DeprecatedConfigProperties.getList(
config,
"otel.instrumentation.http.capture-headers.server.response",
"otel.instrumentation.http.server.capture-response-headers");
config.getList("otel.instrumentation.http.server.capture-response-headers");
knownHttpRequestMethods =
new HashSet<>(
config.getList(
Expand All @@ -71,17 +58,9 @@ public static CommonConfig get() {
statementSanitizationEnabled =
config.getBoolean("otel.instrumentation.common.db-statement-sanitizer.enabled", true);
emitExperimentalHttpClientTelemetry =
DeprecatedConfigProperties.getBoolean(
config,
"otel.instrumentation.http.client.emit-experimental-metrics",
"otel.instrumentation.http.client.emit-experimental-telemetry",
false);
config.getBoolean("otel.instrumentation.http.client.emit-experimental-telemetry", false);
emitExperimentalHttpServerTelemetry =
DeprecatedConfigProperties.getBoolean(
config,
"otel.instrumentation.http.server.emit-experimental-metrics",
"otel.instrumentation.http.server.emit-experimental-telemetry",
false);
config.getBoolean("otel.instrumentation.http.server.emit-experimental-telemetry", false);
enduserConfig = new EnduserConfig(config);
}

Expand Down
50 changes: 0 additions & 50 deletions ...c/main/java/io/opentelemetry/javaagent/bootstrap/internal/DeprecatedConfigProperties.java
View file
Open in desktop

This file was deleted.

9 changes: 9 additions & 0 deletions ...pi/src/main/java/io/opentelemetry/javaagent/bootstrap/internal/InstrumentationConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

package io.opentelemetry.javaagent.bootstrap.internal;

import static java.util.Collections.emptyList;
import static java.util.Objects.requireNonNull;

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

/**
* This is the same as calling {@code getList(String, List)} with the defaultValue equal to the
* emptyList()/
*/
public List<String> getList(String name) {
return getList(name, emptyList());
}

/**
* Returns a list-valued configuration property or {@code defaultValue} if a property with name
* {@code name} has not been configured. The format of the original value must be comma-separated,
Expand Down