Skip to content

[OpenTelemetry] Enable OpenTelemetry stitching with Logs for Dataflow worker #39625

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
stankiewicz wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[OpenTelemetry] Enable OpenTelemetry stitching with Logs for Dataflow worker #39625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 28 additions & 1 deletion ...in/java/org/apache/beam/runners/dataflow/worker/logging/DataflowWorkerLoggingHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@
import com.google.common.collect.Iterables;
import com.google.common.collect.Iterators;
import com.google.protobuf.Struct;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanContext;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileOutputStream;
Expand Down Expand Up @@ -147,6 +149,8 @@ static ResourceBundle resourceBundleForNonDirectLogLevelHint(Level nonDirectLogL
/** If true, add SLF4J MDC to custom_data of the log message. */
private final AtomicBoolean logCustomMdc = new AtomicBoolean(false);

private final AtomicBoolean logOpenTelemetryTraceSpanIdAndSampled = new AtomicBoolean(false);

// Only instantiated and set if enableDirectLogging is called.
private static class DirectLoggingState {
DirectLoggingState(
Expand Down Expand Up @@ -250,6 +254,10 @@ public void setLogMdc(boolean enabled) {
logCustomMdc.set(enabled);
}

public void setLogOpenTelemetryTraceAndSpanId(boolean enabled) {
logOpenTelemetryTraceSpanIdAndSampled.set(enabled);
}

private static Pair<ImmutableMap<String, String>, ImmutableMap<String, String>>
labelsFromOptionsAndMetadata(PipelineOptions options) {
DataflowPipelineOptions dataflowOptions = options.as(DataflowPipelineOptions.class);
Expand Down Expand Up @@ -385,7 +393,16 @@ LogEntry constructDirectLogEntry(
LogEntry.newBuilder(Payload.JsonPayload.of(payloadBuilder.build()))
.setTimestamp(Instant.ofEpochMilli(record.getMillis()))
.setSeverity(severityFor(record.getLevel()));

if (logOpenTelemetryTraceSpanIdAndSampled.get()) {
SpanContext spanContext = Span.current().getSpanContext();
if (spanContext.isValid() && spanContext.isSampled()) {
builder =
builder
.setTrace(spanContext.getTraceId())
.setSpanId(spanContext.getSpanId())
.setTraceSampled(spanContext.isSampled());
}
}
if (stepId != null) {
builder.setResource(
MonitoredResource.newBuilder(RESOURCE_TYPE)
Expand Down Expand Up @@ -606,6 +623,16 @@ public synchronized void publishToDisk(
writeIfNotEmpty(generator, "work", DataflowWorkerLoggingMDC.getWorkId());
writeIfNotEmpty(generator, "logger", record.getLoggerName());
writeIfNotEmpty(generator, "exception", formatException(record.getThrown()));

if (logOpenTelemetryTraceSpanIdAndSampled.get()) {
SpanContext spanContext = Span.current().getSpanContext();
if (spanContext.isValid() && spanContext.isSampled()) {
generator.writeStringField("trace", spanContext.getTraceId());
generator.writeStringField("spanId", spanContext.getSpanId());
generator.writeBooleanField("trace_sampled", spanContext.isSampled());
}
}

if (logCustomMdc.get()) {
@Nullable Map<String, String> mdcMap = MDC.getCopyOfContextMap();
if (mdcMap != null && !mdcMap.isEmpty()) {
Expand Down
4 changes: 4 additions & 0 deletions ...ava/org/apache/beam/runners/dataflow/worker/logging/DataflowWorkerLoggingInitializer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,6 +383,10 @@ public static synchronized void configure(DataflowWorkerLoggingOptions options)
loggingHandler.setLogMdc(true);
}

if (harnessOptions.getLogOpenTelemetryTraceAndSpanId()) {
loggingHandler.setLogOpenTelemetryTraceAndSpanId(true);
}

if (usedDeprecated) {
LOG.warn(
"Deprecated DataflowWorkerLoggingOptions are used for log level settings."
Expand Down
7 changes: 7 additions & 0 deletions sdks/java/core/src/main/java/org/apache/beam/sdk/options/SdkHarnessOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,13 @@ enum LogLevel {

void setLogMdc(boolean value);

@Description(
"This option controls if OpenTelemetry trace, spanId and sampled will be appended to log entries. This will allow to stitch traces to logs.")
@Default.Boolean(false)
boolean getLogOpenTelemetryTraceAndSpanId();

void setLogOpenTelemetryTraceAndSpanId(boolean value);

/** This option controls whether logging will be redirected through the FnApi. */
@Description(
"Controls whether logging will be redirected through the FnApi. In normal usage, setting "
Expand Down
Loading