From 8796ed9379c1dc838468167962dcf28fae54aea3 Mon Sep 17 00:00:00 2001 From: Sam Whittle Date: Mon, 15 Jun 2026 12:17:01 +0200 Subject: [PATCH 1/2] [Dataflow Java] Clarify which portions of DataflowWorkerLoggingOptions are deprecated in preference of equivalent fields in SdkHarnessOptions --- .../options/DataflowWorkerLoggingOptions.java | 36 +++++++++++++++---- 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowWorkerLoggingOptions.java b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowWorkerLoggingOptions.java index ab412d6cfabd..e117d17b65cc 100644 --- a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowWorkerLoggingOptions.java +++ b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowWorkerLoggingOptions.java @@ -30,13 +30,11 @@ /** * Options that are used to control logging configuration on the Dataflow worker. * - * @deprecated This interface will no longer be the source of truth for worker logging configuration - * once jobs are executed using a dedicated SDK harness instead of user code being co-located - * alongside Dataflow worker code. Consider set corresponding options within {@link - * org.apache.beam.sdk.options.SdkHarnessOptions} to ensure forward compatibility. + *

Some options in this interface are no longer the source of truth for worker logging + * configuration. Consider using the corresponding options within {@link + * org.apache.beam.sdk.options.SdkHarnessOptions} to ensure compatibility with other runners. */ @Description("Options that are used to control logging configuration on the Dataflow worker.") -@Deprecated public interface DataflowWorkerLoggingOptions extends PipelineOptions { /** The set of log levels that can be used on the Dataflow worker. */ enum Level { @@ -59,11 +57,19 @@ enum Level { TRACE } - /** This option controls the default log level of all loggers without a log level override. */ + /** + * This option controls the default log level of all loggers without a log level override. + * + * @deprecated Prefer {@link + * org.apache.beam.sdk.options.SdkHarnessOptions#getDefaultSdkHarnessLogLevel()} which works + * across runners. + */ @Description("Controls the default log level of all loggers without a log level override.") @Default.Enum("INFO") + @Deprecated Level getDefaultWorkerLogLevel(); + @Deprecated void setDefaultWorkerLogLevel(Level level); /** @@ -104,14 +110,20 @@ enum Level { *

Note that the message may be filtered depending on the {@link #getDefaultWorkerLogLevel * defaultWorkerLogLevel} or if a {@code System.out} override is specified via {@link * #getWorkerLogLevelOverrides workerLogLevelOverrides}. + * + * @deprecated Prefer using {@link + * org.apache.beam.sdk.options.SdkHarnessOptions#getSdkHarnessLogLevelOverrides()} to override + * the 'System.out' logger as this works across runners. */ @Description( "Controls the log level given to messages printed to System.out. Note that the " + "message may be filtered depending on the defaultWorkerLogLevel or if a 'System.out' " + "override is specified via workerLogLevelOverrides.") @Default.Enum("INFO") + @Deprecated Level getWorkerSystemOutMessageLevel(); + @Deprecated void setWorkerSystemOutMessageLevel(Level level); /** @@ -120,14 +132,20 @@ enum Level { *

Note that the message may be filtered depending on the {@link #getDefaultWorkerLogLevel * defaultWorkerLogLevel} or if a {@code System.err} override is specified via {@link * #getWorkerLogLevelOverrides workerLogLevelOverrides}. + * + * @deprecated Prefer using {@link + * org.apache.beam.sdk.options.SdkHarnessOptions#getSdkHarnessLogLevelOverrides()} to override + * the 'System.err' logger as this works across runners. */ @Description( "Controls the log level given to messages printed to System.err. Note that the " + "message may be filtered depending on the defaultWorkerLogLevel or if a 'System.err' " + "override is specified via workerLogLevelOverrides.") @Default.Enum("ERROR") + @Deprecated Level getWorkerSystemErrMessageLevel(); + @Deprecated void setWorkerSystemErrMessageLevel(Level level); /** @@ -138,6 +156,10 @@ enum Level { *

See {@link WorkerLogLevelOverrides} for more information on how to configure logging on a * per {@link Class}, {@link Package}, or name basis. If used from the command line, the expected * format is {"Name":"Level",...}, further details on {@link WorkerLogLevelOverrides#from}. + * + * @deprecated Prefer using {@link + * org.apache.beam.sdk.options.SdkHarnessOptions#getSdkHarnessLogLevelOverrides()} which works + * across runners. */ @Description( "This option controls the log levels for specifically named loggers. " @@ -149,8 +171,10 @@ enum Level { + "level. System.out and System.err levels are configured via loggers of the corresponding " + "name. Also, note that when multiple overrides are specified, the exact name followed by " + "the closest parent takes precedence.") + @Deprecated WorkerLogLevelOverrides getWorkerLogLevelOverrides(); + @Deprecated void setWorkerLogLevelOverrides(WorkerLogLevelOverrides value); /** From 99ed81975fe0d67d6f86af04ea6c0a68d7cb8ea8 Mon Sep 17 00:00:00 2001 From: Sam Whittle Date: Tue, 16 Jun 2026 10:53:31 +0200 Subject: [PATCH 2/2] fix checkstyle --- .../options/DataflowWorkerLoggingOptions.java | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowWorkerLoggingOptions.java b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowWorkerLoggingOptions.java index e117d17b65cc..89d9f085063c 100644 --- a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowWorkerLoggingOptions.java +++ b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowWorkerLoggingOptions.java @@ -69,6 +69,11 @@ enum Level { @Deprecated Level getDefaultWorkerLogLevel(); + /** + * @deprecated Prefer {@link + * org.apache.beam.sdk.options.SdkHarnessOptions#getDefaultSdkHarnessLogLevel()} which works + * across runners. + */ @Deprecated void setDefaultWorkerLogLevel(Level level); @@ -123,6 +128,11 @@ enum Level { @Deprecated Level getWorkerSystemOutMessageLevel(); + /** + * @deprecated Prefer using {@link + * org.apache.beam.sdk.options.SdkHarnessOptions#getSdkHarnessLogLevelOverrides()} to override + * the 'System.out' logger as this works across runners. + */ @Deprecated void setWorkerSystemOutMessageLevel(Level level); @@ -145,6 +155,11 @@ enum Level { @Deprecated Level getWorkerSystemErrMessageLevel(); + /** + * @deprecated Prefer using {@link + * org.apache.beam.sdk.options.SdkHarnessOptions#getSdkHarnessLogLevelOverrides()} to override + * the 'System.err' logger as this works across runners. + */ @Deprecated void setWorkerSystemErrMessageLevel(Level level); @@ -174,6 +189,11 @@ enum Level { @Deprecated WorkerLogLevelOverrides getWorkerLogLevelOverrides(); + /** + * @deprecated Prefer using {@link + * org.apache.beam.sdk.options.SdkHarnessOptions#getSdkHarnessLogLevelOverrides()} which works + * across runners. + */ @Deprecated void setWorkerLogLevelOverrides(WorkerLogLevelOverrides value);