Skip to content

Report OTLP export status in tracer startup log #12062

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

Open
bm1549 wants to merge 3 commits into
base: master
Choose a base branch
from
+173 −0
Open

Report OTLP export status in tracer startup log #12062

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a4287c5
Add OTLP export flags to tracer startup diagnostic log
bm1549 Jul 23, 2026
6d1065b
Base OTLP export flags on effective writer and span metrics
bm1549 Jul 24, 2026
070e7d8
Derive OTLP export flags in Config and honor MultiWriter
bm1549 Jul 27, 2026
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: 6 additions & 0 deletions dd-trace-core/src/main/java/datadog/trace/core/StatusLogger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,12 @@ public void toJson(JsonWriter writer, Config config) throws IOException {
writer.value(config.isDataStreamsEnabled());
writer.name("data_streams_transaction_extractors");
writer.value(config.getDataStreamsTransactionExtractors());
writer.name("otlp_traces_export_enabled");
writer.value(config.isOtlpTracesExportEnabled());
writer.name("otlp_metrics_export_enabled");
writer.value(config.isOtlpMetricsExportEnabled());
writer.name("otlp_logs_export_enabled");
writer.value(config.isOtlpLogsExportEnabled());

writer.name("app_logs_collection_enabled");
writer.value(config.isAppLogsCollectionEnabled());
Expand Down
141 changes: 141 additions & 0 deletions dd-trace-core/src/test/java/datadog/trace/core/StatusLoggerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
package datadog.trace.core;

import static datadog.trace.api.config.OtlpConfig.LOGS_OTEL_ENABLED;
import static datadog.trace.api.config.OtlpConfig.LOGS_OTEL_EXPORTER;
import static datadog.trace.api.config.OtlpConfig.METRICS_OTEL_ENABLED;
import static datadog.trace.api.config.OtlpConfig.METRICS_OTEL_EXPORTER;
import static datadog.trace.api.config.OtlpConfig.OTEL_TRACES_SPAN_METRICS_ENABLED;
import static datadog.trace.api.config.OtlpConfig.TRACE_OTEL_EXPORTER;
import static datadog.trace.api.config.TracerConfig.WRITER_TYPE;
import static datadog.trace.bootstrap.instrumentation.api.WriterConstants.DD_AGENT_WRITER_TYPE;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;

import com.squareup.moshi.Moshi;
import datadog.trace.api.Config;
import datadog.trace.test.junit.utils.config.WithConfig;
import datadog.trace.test.util.DDJavaSpecification;
import java.io.IOException;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.Timeout;

@Timeout(value = 10, unit = TimeUnit.SECONDS)
public class StatusLoggerTest extends DDJavaSpecification {

@Test
void otlpExportDisabledByDefault() throws IOException {
Map<String, Object> startupLog = startupLog();

assertFalse(flag(startupLog, "otlp_traces_export_enabled"));
assertFalse(flag(startupLog, "otlp_metrics_export_enabled"));
assertFalse(flag(startupLog, "otlp_logs_export_enabled"));
}

@Test
@WithConfig(key = TRACE_OTEL_EXPORTER, value = "otlp")
@WithConfig(key = METRICS_OTEL_ENABLED, value = "true")
@WithConfig(key = METRICS_OTEL_EXPORTER, value = "otlp")
@WithConfig(key = LOGS_OTEL_ENABLED, value = "true")
@WithConfig(key = LOGS_OTEL_EXPORTER, value = "otlp")
void otlpExportEnabledWhenConfigured() throws IOException {
Map<String, Object> startupLog = startupLog();

assertTrue(flag(startupLog, "otlp_traces_export_enabled"));
assertTrue(flag(startupLog, "otlp_metrics_export_enabled"));
assertTrue(flag(startupLog, "otlp_logs_export_enabled"));
}

@Test
@WithConfig(key = TRACE_OTEL_EXPORTER, value = "otlp")
@WithConfig(key = METRICS_OTEL_EXPORTER, value = "otlp")
@WithConfig(key = LOGS_OTEL_EXPORTER, value = "otlp")
void metricsAndLogsRequireOtelSignalEnabled() throws IOException {
Map<String, Object> startupLog = startupLog();

assertTrue(flag(startupLog, "otlp_traces_export_enabled"));
assertFalse(flag(startupLog, "otlp_metrics_export_enabled"));
assertFalse(flag(startupLog, "otlp_logs_export_enabled"));
}

@Test
@WithConfig(key = TRACE_OTEL_EXPORTER, value = "otlp")
@WithConfig(key = WRITER_TYPE, value = DD_AGENT_WRITER_TYPE)
void tracesNotExportedWhenWriterTypeOverridesOtlpExporter() throws IOException {
assertFalse(flag(startupLog(), "otlp_traces_export_enabled"));
}

@Test
@WithConfig(key = WRITER_TYPE, value = "MultiWriter:OtlpWriter,DDAgentWriter")
void tracesExportedWhenMultiWriterIncludesOtlpWriter() throws IOException {
assertTrue(flag(startupLog(), "otlp_traces_export_enabled"));
}

@Test
@WithConfig(key = WRITER_TYPE, value = "MultiWriter:DDAgentWriter,MultiWriter:OtlpWriter")
void tracesExportedWhenMultiWriterPrefixRepeats() throws IOException {
assertTrue(flag(startupLog(), "otlp_traces_export_enabled"));
}

@Test
@WithConfig(key = WRITER_TYPE, value = "MultiWriter:LoggingWriter,DDAgentWriter")
void tracesNotExportedWhenMultiWriterExcludesOtlpWriter() throws IOException {
assertFalse(flag(startupLog(), "otlp_traces_export_enabled"));
}

@Test
@WithConfig(key = WRITER_TYPE, value = "MultiWriter: OtlpWriter")
void tracesNotExportedWhenMultiWriterSubTypeIsPadded() throws IOException {
assertFalse(flag(startupLog(), "otlp_traces_export_enabled"));
}

@Test
@WithConfig(key = WRITER_TYPE, value = "MultiWriter:OtlpWriterExtra")
void tracesNotExportedWhenMultiWriterSubTypeOnlyPrefixesOtlpWriter() throws IOException {
assertFalse(flag(startupLog(), "otlp_traces_export_enabled"));
}

@Test
@WithConfig(key = WRITER_TYPE, value = "DDAgentWriter,OtlpWriter")
void tracesNotExportedWhenCommaSeparatedWithoutMultiWriterPrefix() throws IOException {
assertFalse(flag(startupLog(), "otlp_traces_export_enabled"));
}

@Test
@WithConfig(key = WRITER_TYPE, value = "TraceStructureWriter:/tmp/out,OtlpWriter")
void tracesNotExportedWhenTraceStructureWriterTakesPrecedence() throws IOException {
assertFalse(flag(startupLog(), "otlp_traces_export_enabled"));
}

@Test
@WithConfig(key = OTEL_TRACES_SPAN_METRICS_ENABLED, value = "true")
void metricsExportedWhenSpanMetricsEnabled() throws IOException {
assertTrue(flag(startupLog(), "otlp_metrics_export_enabled"));
}

@Test
@WithConfig(key = METRICS_OTEL_ENABLED, value = "true")
@WithConfig(key = METRICS_OTEL_EXPORTER, value = "otlp")
@WithConfig(key = OTEL_TRACES_SPAN_METRICS_ENABLED, value = "false")
void metricsExportedWhenOtelMetricsSignalEnabledWithoutSpanMetrics() throws IOException {
assertTrue(flag(startupLog(), "otlp_metrics_export_enabled"));
}

@SuppressWarnings("unchecked")
private static Map<String, Object> startupLog() throws IOException {
String json =
new Moshi.Builder()
.add(new StatusLogger())
.build()
.adapter(Config.class)
.toJson(Config.get());
return (Map<String, Object>) new Moshi.Builder().build().adapter(Object.class).fromJson(json);
}

private static boolean flag(Map<String, Object> startupLog, String name) {
Object value = startupLog.get(name);
assertTrue(value instanceof Boolean, name + " should be a boolean, was " + value);
return (Boolean) value;
}
}
26 changes: 26 additions & 0 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 @@ -727,6 +727,7 @@
import static datadog.trace.api.config.TracerConfig.WRITER_LINKS_INJECT;
import static datadog.trace.api.config.TracerConfig.WRITER_TYPE;
import static datadog.trace.api.telemetry.LogCollector.SEND_TELEMETRY;
import static datadog.trace.bootstrap.instrumentation.api.WriterConstants.MULTI_WRITER_TYPE;
import static datadog.trace.bootstrap.instrumentation.api.WriterConstants.OTLP_WRITER_TYPE;
import static datadog.trace.util.CollectionUtils.tryMakeImmutableList;
import static datadog.trace.util.CollectionUtils.tryMakeImmutableSet;
Expand Down Expand Up @@ -828,6 +829,9 @@ public class Config {
private static final int MAX_CODE_COVERAGE_FLAGS = 32;

private static final Pattern COLON = Pattern.compile(":");
private static final Pattern COMMA = Pattern.compile(",");
private static final Pattern MULTI_WRITER_PREFIX =
Pattern.compile(MULTI_WRITER_TYPE + ":", Pattern.LITERAL);

@mcculls mcculls Jul 27, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This will never be used for most deployments, and is the same as dropping the same number of characters as the matched string (+ 1) from the string.


// Historical conflating-Batch size; used to translate TRACER_METRICS_MAX_PENDING (configured in
// legacy batch units) into the new per-SpanSnapshot inbox capacity.
Expand Down Expand Up @@ -5577,6 +5581,10 @@ public boolean isLogsOtlpExporterEnabled() {
return "otlp".equalsIgnoreCase(logsOtelExporter);
}

public boolean isOtlpLogsExportEnabled() {
return isLogsOtelEnabled() && isLogsOtlpExporterEnabled();
}

public int getLogsOtelInterval() {
return logsOtelInterval;
}
Expand Down Expand Up @@ -5621,6 +5629,11 @@ public boolean isMetricsOtlpExporterEnabled() {
return "otlp".equalsIgnoreCase(metricsOtelExporter);
}

public boolean isOtlpMetricsExportEnabled() {
return (isMetricsOtelEnabled() && isMetricsOtlpExporterEnabled())
|| isOtelTracesSpanMetricsEnabled();
}

public boolean isMetricsOtelExperimentalEnabled() {
return metricsOtelExperimentalEnabled;
}
Expand Down Expand Up @@ -5677,6 +5690,19 @@ public boolean isTraceOtlpExporterEnabled() {
return "otlp".equalsIgnoreCase(traceOtelExporter);
}

public boolean isOtlpTracesExportEnabled() {
if (!writerType.startsWith(MULTI_WRITER_TYPE)) {
return OTLP_WRITER_TYPE.equals(writerType);
}
String multiWriterConfig = MULTI_WRITER_PREFIX.matcher(writerType).replaceAll("");

@mcculls mcculls Jul 27, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
String multiWriterConfig = MULTI_WRITER_PREFIX.matcher(writerType).replaceAll("");
String multiWriterConfig = writerType.substring(MULTI_WRITER_TYPE.length() + 1);

saves needing the extra regex, which almost all the time will never be used.

for (String subWriterType : COMMA.split(multiWriterConfig)) {

@mcculls mcculls Jul 27, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Given that almost all deployments will never reach this code, is it worth pre-compiling the regex and always taking that hit - rather than just using multiWriterConfig.split(","); and doing it lazily?

if (OTLP_WRITER_TYPE.equals(subWriterType)) {
return true;
}
}
return false;
}

public String getOtlpTracesEndpoint() {
return otlpTracesEndpoint;
}
Expand Down
Loading