This is an automated email from the ASF dual-hosted git repository.
scwhittle pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/beam.git
The following commit(s) were added to refs/heads/master by this push:
new 2c53494f735 [Dataflow Java] Clarify which portions of
DataflowWorkerLoggingOptions are deprecated (#38960)
2c53494f735 is described below
commit 2c53494f7356b076e72d6df60fe3016969b9df30
Author: Sam Whittle <[email protected]>
AuthorDate: Tue Jun 16 20:30:09 2026 +0200
[Dataflow Java] Clarify which portions of DataflowWorkerLoggingOptions are
deprecated (#38960)
Clarify which portions of DataflowWorkerLoggingOptions are deprecated in
preference of equivalent fields in SdkHarnessOptions
---
.../options/DataflowWorkerLoggingOptions.java | 56 +++++++++++++++++++---
1 file changed, 50 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 ab412d6cfab..89d9f085063 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 @@ import org.apache.beam.sdk.options.PipelineOptions;
/**
* 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.
+ * <p>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,24 @@ public interface DataflowWorkerLoggingOptions extends
PipelineOptions {
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 Prefer {@link
+ *
org.apache.beam.sdk.options.SdkHarnessOptions#getDefaultSdkHarnessLogLevel()}
which works
+ * across runners.
+ */
+ @Deprecated
void setDefaultWorkerLogLevel(Level level);
/**
@@ -104,14 +115,25 @@ public interface DataflowWorkerLoggingOptions extends
PipelineOptions {
* <p>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 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);
/**
@@ -120,14 +142,25 @@ public interface DataflowWorkerLoggingOptions extends
PipelineOptions {
* <p>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 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);
/**
@@ -138,6 +171,10 @@ public interface DataflowWorkerLoggingOptions extends
PipelineOptions {
* <p>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 +186,15 @@ public interface DataflowWorkerLoggingOptions extends
PipelineOptions {
+ "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 Prefer using {@link
+ *
org.apache.beam.sdk.options.SdkHarnessOptions#getSdkHarnessLogLevelOverrides()}
which works
+ * across runners.
+ */
+ @Deprecated
void setWorkerLogLevelOverrides(WorkerLogLevelOverrides value);
/**
