Skip to content

Config Consistency Round 2 #8489

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

Merged
merged 23 commits into from
Mar 19, 2025
Merged

Config Consistency Round 2 #8489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
2dfeef7
trigger ci
mhlidd Mar 3, 2025
cb696e8
fixing tests
mhlidd Mar 3, 2025
26a26b3
fixing smoke test
mhlidd Mar 4, 2025
4281882
running CI
mhlidd Mar 4, 2025
9aae508
fixing more smoke tests
mhlidd Mar 4, 2025
f0b15b4
cleanup
mhlidd Mar 4, 2025
b24d13b
testing islogging128bittraceidenabled migration to config
mhlidd Mar 5, 2025
00ab390
fixing small error
mhlidd Mar 5, 2025
48a8059
adding to toString
mhlidd Mar 6, 2025
505f88e
Merge branch 'master' into mhlidd/config_consistency
mhlidd Mar 6, 2025
da164b0
updating experimental features from list to set
mhlidd Mar 7, 2025
e6af653
Merge branch 'master' into mhlidd/config_consistency
mhlidd Mar 11, 2025
0b0ad8a
Merge branch 'master' into mhlidd/config_consistency
mhlidd Mar 11, 2025
8675886
updating PR comments
mhlidd Mar 11, 2025
8c7027b
Adding test to verify behavior for configs under feature falg
mhlidd Mar 12, 2025
23038a2
Merge branch 'master' into mhlidd/config_consistency
mhlidd Mar 14, 2025
6dc399a
updating test
mhlidd Mar 14, 2025
df2dffb
updating config value when not under breaking_changed feature flag
mhlidd Mar 17, 2025
335d316
Merge branch 'master' into mhlidd/config_consistency
mhlidd Mar 17, 2025
35dc923
cleanup and nit responses
mhlidd Mar 17, 2025
914f47a
nit pt 2
mhlidd Mar 17, 2025
a53ff2e
Merge branch 'master' into mhlidd/config_consistency
mhlidd Mar 17, 2025
884e147
Merge branch 'master' into mhlidd/config_consistency
mhlidd Mar 18, 2025
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
6 changes: 2 additions & 4 deletions .../main/java/datadog/trace/instrumentation/jbosslogmanager/ExtLogRecordInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
import datadog.trace.api.CorrelationIdentifier;
import datadog.trace.api.DDSpanId;
import datadog.trace.api.DDTraceId;
import datadog.trace.api.InstrumenterConfig;
import datadog.trace.bootstrap.InstrumentationContext;
import datadog.trace.bootstrap.instrumentation.api.AgentSpanContext;
import datadog.trace.bootstrap.instrumentation.api.AgentTracer;
Expand Down Expand Up @@ -113,8 +112,7 @@ public static void getMdcValue(
case "dd.trace_id":
if (context != null) {
DDTraceId traceId = context.getTraceId();
if (traceId.toHighOrderLong() != 0
&& InstrumenterConfig.get().isLogs128bTraceIdEnabled()) {
if (traceId.toHighOrderLong() != 0 && Config.get().isLogs128bitTraceIdEnabled()) {
value = traceId.toHexString();
} else {
value = traceId.toString();
Expand Down Expand Up @@ -155,7 +153,7 @@ public static void onExit(
if (context != null) {
DDTraceId traceId = context.getTraceId();
String traceIdValue =
InstrumenterConfig.get().isLogs128bTraceIdEnabled() && traceId.toHighOrderLong() != 0
Config.get().isLogs128bitTraceIdEnabled() && traceId.toHighOrderLong() != 0
? traceId.toHexString()
: traceId.toString();
correlationValues.put(CorrelationIdentifier.getTraceIdKey(), traceIdValue);
Expand Down
3 changes: 1 addition & 2 deletions ...rc/main/java/datadog/trace/instrumentation/log4j27/SpanDecoratingContextDataInjector.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
import datadog.trace.api.CorrelationIdentifier;
import datadog.trace.api.DDSpanId;
import datadog.trace.api.DDTraceId;
import datadog.trace.api.InstrumenterConfig;
import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
import datadog.trace.bootstrap.instrumentation.api.Tags;
import java.util.List;
Expand Down Expand Up @@ -57,7 +56,7 @@ public StringMap injectContextData(List<Property> list, StringMap reusable) {
if (span != null) {
DDTraceId traceId = span.context().getTraceId();
String traceIdValue =
InstrumenterConfig.get().isLogs128bTraceIdEnabled() && traceId.toHighOrderLong() != 0
Config.get().isLogs128bitTraceIdEnabled() && traceId.toHighOrderLong() != 0
? traceId.toHexString()
: traceId.toString();
newContextData.putValue(CorrelationIdentifier.getTraceIdKey(), traceIdValue);
Expand Down
6 changes: 2 additions & 4 deletions ...og4j1/src/main/java/datadog/trace/instrumentation/log4j1/LoggingEventInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
import datadog.trace.api.CorrelationIdentifier;
import datadog.trace.api.DDSpanId;
import datadog.trace.api.DDTraceId;
import datadog.trace.api.InstrumenterConfig;
import datadog.trace.bootstrap.InstrumentationContext;
import datadog.trace.bootstrap.instrumentation.api.AgentSpanContext;
import datadog.trace.bootstrap.instrumentation.api.AgentTracer;
Expand Down Expand Up @@ -95,8 +94,7 @@ public static void getMdcValue(
case "dd.trace_id":
if (context != null) {
DDTraceId traceId = context.getTraceId();
if (traceId.toHighOrderLong() != 0
&& InstrumenterConfig.get().isLogs128bTraceIdEnabled()) {
if (traceId.toHighOrderLong() != 0 && Config.get().isLogs128bitTraceIdEnabled()) {
value = traceId.toHexString();
} else {
value = traceId.toString();
Expand Down Expand Up @@ -157,7 +155,7 @@ public static void onExit(
if (context != null) {
DDTraceId traceId = context.getTraceId();
String traceIdValue =
InstrumenterConfig.get().isLogs128bTraceIdEnabled() && traceId.toHighOrderLong() != 0
Config.get().isLogs128bitTraceIdEnabled() && traceId.toHighOrderLong() != 0
? traceId.toHexString()
: traceId.toString();
mdc.put(CorrelationIdentifier.getTraceIdKey(), traceIdValue);
Expand Down
3 changes: 1 addition & 2 deletions ...ck-1/src/main/java/datadog/trace/instrumentation/logback/LoggingEventInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
import datadog.trace.api.CorrelationIdentifier;
import datadog.trace.api.DDSpanId;
import datadog.trace.api.DDTraceId;
import datadog.trace.api.InstrumenterConfig;
import datadog.trace.bootstrap.InstrumentationContext;
import datadog.trace.bootstrap.instrumentation.api.AgentSpanContext;
import datadog.trace.bootstrap.instrumentation.api.AgentTracer;
Expand Down Expand Up @@ -90,7 +89,7 @@ public static void onExit(
if (context != null) {
DDTraceId traceId = context.getTraceId();
String traceIdValue =
InstrumenterConfig.get().isLogs128bTraceIdEnabled() && traceId.toHighOrderLong() != 0
Config.get().isLogs128bitTraceIdEnabled() && traceId.toHighOrderLong() != 0
? traceId.toHexString()
: traceId.toString();
correlationValues.put(CorrelationIdentifier.getTraceIdKey(), traceIdValue);
Expand Down
3 changes: 1 addition & 2 deletions ...nylog-2/src/main/java/datadog/trace/instrumentation/tinylog2/LogEntryInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
import datadog.trace.api.CorrelationIdentifier;
import datadog.trace.api.DDSpanId;
import datadog.trace.api.DDTraceId;
import datadog.trace.api.InstrumenterConfig;
import datadog.trace.bootstrap.InstrumentationContext;
import datadog.trace.bootstrap.instrumentation.api.AgentSpanContext;
import datadog.trace.bootstrap.instrumentation.api.AgentTracer;
Expand Down Expand Up @@ -83,7 +82,7 @@ public static void onExit(
if (context != null) {
DDTraceId traceId = context.getTraceId();
String traceIdValue =
InstrumenterConfig.get().isLogs128bTraceIdEnabled() && traceId.toHighOrderLong() != 0
Config.get().isLogs128bitTraceIdEnabled() && traceId.toHighOrderLong() != 0
? traceId.toHexString()
: traceId.toString();
correlationValues.put(CorrelationIdentifier.getTraceIdKey(), traceIdValue);
Expand Down
4 changes: 4 additions & 0 deletions ...src/main/groovy/datadog/trace/agent/test/log/injection/LogContextInjectionTestBase.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ abstract class LogContextInjectionTestBase extends AgentTestRunner {

abstract Map<String, Object> getMap()

def setup() {
injectSysConfig("logs.injection.enabled", "true")
Copy link
Contributor

@mcculls mcculls Mar 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

this should already be the default? https://github.com/DataDog/dd-trace-java/blob/master/dd-trace-api/src/main/java/datadog/trace/api/ConfigDefaults.java#L105

never mind - I see the default is being changed below

this will be a breaking change for a lot of customers, is there a plan to mitigate this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I can add it under the DD_TRACE_EXPERIMENTAL_FEATURES_ENABLED flag.

Copy link
Contributor

Choose a reason for hiding this comment

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

This change could be dropped, now we're only changing the default when enabling breaking changes

}

def "Log context shows trace and span ids for active scope"() {
when:
put("foo", "bar")
Expand Down
8 changes: 4 additions & 4 deletions dd-smoke-tests/log-injection/src/test/groovy/datadog/smoketest/LogInjectionSmokeTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ abstract class LogInjectionSmokeTest extends AbstractSmokeTest {
boolean noTags = false

@Shared
boolean trace128bits = false
boolean trace128bits = true

@Shared
@AutoCleanup
Expand Down Expand Up @@ -88,9 +88,9 @@ abstract class LogInjectionSmokeTest extends AbstractSmokeTest {
command.add("-Ddd.version=" as String)
command.add("-Ddd.service.name=" as String)
}
if (trace128bits) {
command.add("-Ddd.$TRACE_128_BIT_TRACEID_GENERATION_ENABLED=true" as String)
command.add("-Ddd.$TRACE_128_BIT_TRACEID_LOGGING_ENABLED=true" as String)
if (!trace128bits) {
command.add("-Ddd.$TRACE_128_BIT_TRACEID_GENERATION_ENABLED=false" as String)
command.add("-Ddd.$TRACE_128_BIT_TRACEID_LOGGING_ENABLED=false" as String)
}
if (supportsDirectLogSubmission()) {
command.add("-Ddd.$GeneralConfig.AGENTLESS_LOG_SUBMISSION_ENABLED=true" as String)
Expand Down
4 changes: 3 additions & 1 deletion dd-trace-api/src/main/java/datadog/trace/api/ConfigDefaults.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,8 @@ public final class ConfigDefaults {
static final boolean DEFAULT_PERF_METRICS_ENABLED = false;
// No default constants for metrics statsd support -- falls back to jmxfetch values

// Change value to be false in new release. Until then, manually set logs_injection default
// value to false if config is under breaking changes flag
static final boolean DEFAULT_LOGS_INJECTION_ENABLED = true;

static final String DEFAULT_APPSEC_ENABLED = "inactive";
Expand Down Expand Up @@ -235,7 +237,7 @@ public final class ConfigDefaults {
static final Set<String> DEFAULT_TRACE_EXPERIMENTAL_FEATURES_ENABLED = new HashSet<>();

static final boolean DEFAULT_TRACE_128_BIT_TRACEID_GENERATION_ENABLED = true;
static final boolean DEFAULT_TRACE_128_BIT_TRACEID_LOGGING_ENABLED = false;
static final boolean DEFAULT_TRACE_128_BIT_TRACEID_LOGGING_ENABLED = true;
static final boolean DEFAULT_SECURE_RANDOM = false;

public static final int DEFAULT_TRACE_X_DATADOG_TAGS_MAX_LENGTH = 512;
Expand Down
3 changes: 1 addition & 2 deletions dd-trace-core/src/main/java/datadog/trace/core/CoreTracer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
import datadog.trace.api.DynamicConfig;
import datadog.trace.api.EndpointTracker;
import datadog.trace.api.IdGenerationStrategy;
import datadog.trace.api.InstrumenterConfig;
import datadog.trace.api.StatsDClient;
import datadog.trace.api.TraceConfig;
import datadog.trace.api.config.GeneralConfig;
Expand Down Expand Up @@ -605,7 +604,7 @@ private CoreTracer(
.setTracingTags(config.getMergedSpanTags())
.apply();

this.logs128bTraceIdEnabled = InstrumenterConfig.get().isLogs128bTraceIdEnabled();
this.logs128bTraceIdEnabled = Config.get().isLogs128bitTraceIdEnabled();
this.partialFlushMinSpans = partialFlushMinSpans;
this.idGenerationStrategy =
null == idGenerationStrategy
Expand Down
24 changes: 21 additions & 3 deletions internal-api/src/main/java/datadog/trace/api/Config.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -483,6 +483,7 @@ public static String getHostName() {
private final boolean secureRandom;

private final boolean trace128bitTraceIdGenerationEnabled;
private final boolean logs128bitTraceIdEnabled;

private final Set<String> grpcIgnoredInboundMethods;
private final Set<String> grpcIgnoredOutboundMethods;
Expand Down Expand Up @@ -664,6 +665,11 @@ private Config(final ConfigProvider configProvider, final InstrumenterConfig ins
configProvider.getBoolean(
TRACE_128_BIT_TRACEID_GENERATION_ENABLED,
DEFAULT_TRACE_128_BIT_TRACEID_GENERATION_ENABLED);

logs128bitTraceIdEnabled =
configProvider.getBoolean(
TRACE_128_BIT_TRACEID_LOGGING_ENABLED, DEFAULT_TRACE_128_BIT_TRACEID_LOGGING_ENABLED);

if (secureRandom) {
strategyName = "SECURE_RANDOM";
}
Expand Down Expand Up @@ -1034,9 +1040,15 @@ private Config(final ConfigProvider configProvider, final InstrumenterConfig ins

clockSyncPeriod = configProvider.getInteger(CLOCK_SYNC_PERIOD, DEFAULT_CLOCK_SYNC_PERIOD);

logsInjectionEnabled =
configProvider.getBoolean(
LOGS_INJECTION_ENABLED, DEFAULT_LOGS_INJECTION_ENABLED, LOGS_INJECTION);
if (experimentalFeaturesEnabled.contains(
propertyNameToEnvironmentVariableName(LOGS_INJECTION))) {
logsInjectionEnabled =
configProvider.getBoolean(LOGS_INJECTION_ENABLED, false, LOGS_INJECTION);
} else {
logsInjectionEnabled =
configProvider.getBoolean(
LOGS_INJECTION_ENABLED, DEFAULT_LOGS_INJECTION_ENABLED, LOGS_INJECTION);
}

dogStatsDNamedPipe = configProvider.getString(DOGSTATSD_NAMED_PIPE);

Expand Down Expand Up @@ -3461,6 +3473,10 @@ public boolean isTrace128bitTraceIdGenerationEnabled() {
return trace128bitTraceIdGenerationEnabled;
}

public boolean isLogs128bitTraceIdEnabled() {
return logs128bitTraceIdEnabled;
}

public Set<String> getGrpcIgnoredInboundMethods() {
return grpcIgnoredInboundMethods;
}
Expand Down Expand Up @@ -4711,6 +4727,8 @@ public String toString() {
+ idGenerationStrategy
+ ", trace128bitTraceIdGenerationEnabled="
+ trace128bitTraceIdGenerationEnabled
+ ", logs128bitTraceIdEnabled="
+ logs128bitTraceIdEnabled
+ ", grpcIgnoredInboundMethods="
+ grpcIgnoredInboundMethods
+ ", grpcIgnoredOutboundMethods="
Expand Down
13 changes: 1 addition & 12 deletions internal-api/src/main/java/datadog/trace/api/InstrumenterConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
import static datadog.trace.api.ConfigDefaults.DEFAULT_RUNTIME_CONTEXT_FIELD_INJECTION;
import static datadog.trace.api.ConfigDefaults.DEFAULT_SERIALVERSIONUID_FIELD_INJECTION;
import static datadog.trace.api.ConfigDefaults.DEFAULT_TELEMETRY_ENABLED;
import static datadog.trace.api.ConfigDefaults.DEFAULT_TRACE_128_BIT_TRACEID_LOGGING_ENABLED;
import static datadog.trace.api.ConfigDefaults.DEFAULT_TRACE_ANNOTATIONS;
import static datadog.trace.api.ConfigDefaults.DEFAULT_TRACE_ANNOTATION_ASYNC;
import static datadog.trace.api.ConfigDefaults.DEFAULT_TRACE_ENABLED;
Expand Down Expand Up @@ -52,7 +51,6 @@
import static datadog.trace.api.config.TraceInstrumentationConfig.RESOLVER_USE_URL_CACHES;
import static datadog.trace.api.config.TraceInstrumentationConfig.RUNTIME_CONTEXT_FIELD_INJECTION;
import static datadog.trace.api.config.TraceInstrumentationConfig.SERIALVERSIONUID_FIELD_INJECTION;
import static datadog.trace.api.config.TraceInstrumentationConfig.TRACE_128_BIT_TRACEID_LOGGING_ENABLED;
import static datadog.trace.api.config.TraceInstrumentationConfig.TRACE_ANNOTATIONS;
import static datadog.trace.api.config.TraceInstrumentationConfig.TRACE_ANNOTATION_ASYNC;
import static datadog.trace.api.config.TraceInstrumentationConfig.TRACE_CLASSES_EXCLUDE;
Expand Down Expand Up @@ -107,7 +105,6 @@ public class InstrumenterConfig {
private final boolean codeOriginEnabled;
private final boolean traceEnabled;
private final boolean traceOtelEnabled;
private final boolean logs128bTraceIdEnabled;
private final ProfilingEnablement profilingEnabled;
private final boolean ciVisibilityEnabled;
private final ProductActivation appSecActivation;
Expand Down Expand Up @@ -185,9 +182,7 @@ private InstrumenterConfig() {
CODE_ORIGIN_FOR_SPANS_ENABLED, DEFAULT_CODE_ORIGIN_FOR_SPANS_ENABLED);
traceEnabled = configProvider.getBoolean(TRACE_ENABLED, DEFAULT_TRACE_ENABLED);
traceOtelEnabled = configProvider.getBoolean(TRACE_OTEL_ENABLED, DEFAULT_TRACE_OTEL_ENABLED);
logs128bTraceIdEnabled =
configProvider.getBoolean(
TRACE_128_BIT_TRACEID_LOGGING_ENABLED, DEFAULT_TRACE_128_BIT_TRACEID_LOGGING_ENABLED);

profilingEnabled =
ProfilingEnablement.of(
configProvider.getString(PROFILING_ENABLED, String.valueOf(PROFILING_ENABLED_DEFAULT)));
Expand Down Expand Up @@ -342,10 +337,6 @@ public boolean isTraceOtelEnabled() {
return traceOtelEnabled;
}

public boolean isLogs128bTraceIdEnabled() {
return logs128bTraceIdEnabled;
}

public boolean isProfilingEnabled() {
return profilingEnabled.isActive();
}
Expand Down Expand Up @@ -567,8 +558,6 @@ public String toString() {
+ traceEnabled
+ ", traceOtelEnabled="
+ traceOtelEnabled
+ ", logs128bTraceIdEnabled="
+ logs128bTraceIdEnabled
+ ", profilingEnabled="
+ profilingEnabled
+ ", ciVisibilityEnabled="
Expand Down
6 changes: 4 additions & 2 deletions internal-api/src/test/groovy/datadog/trace/api/ConfigTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1894,16 +1894,17 @@ class ConfigTest extends DDSpecification {

def "verify behavior of features under DD_TRACE_EXPERIMENTAL_FEATURES_ENABLED"() {
setup:
environmentVariables.set("DD_TRACE_EXPERIMENTAL_FEATURES_ENABLED", "DD_TAGS")
environmentVariables.set("DD_TRACE_EXPERIMENTAL_FEATURES_ENABLED", "DD_LOGS_INJECTION, DD_TAGS")
environmentVariables.set("DD_TAGS", "env:test,aKey:aVal bKey:bVal cKey:")

when:
def config = new Config()

then:
config.experimentalFeaturesEnabled == ["DD_TAGS"].toSet()
config.experimentalFeaturesEnabled == ["DD_LOGS_INJECTION", "DD_TAGS"].toSet()

//verify expected behavior enabled under feature flag
config.logsInjectionEnabled == false
config.globalTags == [env: "test", aKey: "aVal bKey:bVal cKey:"]
}

Expand All @@ -1918,6 +1919,7 @@ class ConfigTest extends DDSpecification {
config.experimentalFeaturesEnabled == [].toSet()

//verify expected behavior when not enabled under feature flag
config.logsInjectionEnabled == true
config.globalTags == [env:"test", aKey:"aVal", bKey:"bVal"]
}

Expand Down