Package org.apache.beam.runners.dataflow.options

Interface DataflowWorkerLoggingOptions

All Superinterfaces:

HasDisplayData, PipelineOptions

All Known Subinterfaces:

DataflowPipelineOptions, DataflowWorkerHarnessOptions, TestDataflowPipelineOptions

@Deprecated
public interface DataflowWorkerLoggingOptions
extends PipelineOptions

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 SdkHarnessOptions to ensure forward compatibility.

Options that are used to control logging configuration on the Dataflow worker.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	DataflowWorkerLoggingOptions.Level	Deprecated. The set of log levels that can be used on the Dataflow worker.
static class	DataflowWorkerLoggingOptions.WorkerLogLevelOverrides	Deprecated. Defines a log level override for a specific class, package, or name.

Nested classes/interfaces inherited from interface org.apache.beam.sdk.options.PipelineOptions

PipelineOptions.AtomicLongFactory, PipelineOptions.CheckEnabled, PipelineOptions.DirectRunner, PipelineOptions.JobNameFactory, PipelineOptions.UserAgentFactory

Method Summary

Modifier and Type	Method	Description
DataflowWorkerLoggingOptions.Level	getDefaultWorkerDirectLoggerLevel()	Deprecated. Controls the log level for which messages are uploaded to Cloud Logging.
DataflowWorkerLoggingOptions.Level	getDefaultWorkerLogLevel()	Deprecated. This option controls the default log level of all loggers without a log level override.
Integer	getDirectLoggingCooldownSeconds()	Deprecated.
Boolean	getDirectLoggingFallbackToDiskOnErrors()	Deprecated.
Long	getWorkerDirectLoggerBufferByteLimit()	Deprecated.
Long	getWorkerDirectLoggerBufferElementLimit()	Deprecated.
DataflowWorkerLoggingOptions.WorkerLogLevelOverrides	getWorkerDirectLogLevelOverrides()	Deprecated. This option controls the direct log levels for specifically named loggers.
DataflowWorkerLoggingOptions.WorkerLogLevelOverrides	getWorkerLogLevelOverrides()	Deprecated. This option controls the log levels for specifically named loggers.
DataflowWorkerLoggingOptions.Level	getWorkerSystemErrMessageLevel()	Deprecated. Controls the log level given to messages printed to System.err.
DataflowWorkerLoggingOptions.Level	getWorkerSystemOutMessageLevel()	Deprecated. Controls the log level given to messages printed to System.out.
void	setDefaultWorkerDirectLoggerLevel(DataflowWorkerLoggingOptions.Level level)	Deprecated.
void	setDefaultWorkerLogLevel(DataflowWorkerLoggingOptions.Level level)	Deprecated.
void	setDirectLoggingCooldownSeconds(Integer value)	Deprecated.
void	setDirectLoggingFallbackToDiskOnErrors(Boolean value)	Deprecated.
void	setWorkerDirectLoggerBufferByteLimit(Long value)	Deprecated.
void	setWorkerDirectLoggerBufferElementLimit(Long value)	Deprecated.
void	setWorkerDirectLogLevelOverrides(DataflowWorkerLoggingOptions.WorkerLogLevelOverrides value)	Deprecated.
void	setWorkerLogLevelOverrides(DataflowWorkerLoggingOptions.WorkerLogLevelOverrides value)	Deprecated.
void	setWorkerSystemErrMessageLevel(DataflowWorkerLoggingOptions.Level level)	Deprecated.
void	setWorkerSystemOutMessageLevel(DataflowWorkerLoggingOptions.Level level)	Deprecated.

Methods inherited from interface org.apache.beam.sdk.transforms.display.HasDisplayData

populateDisplayData

Methods inherited from interface org.apache.beam.sdk.options.PipelineOptions

as, getGbek, getJobName, getOptionsId, getRunner, getStableUniqueNames, getTempLocation, getUserAgent, outputRuntimeOptions, revision, setGbek, setJobName, setOptionsId, setRunner, setStableUniqueNames, setTempLocation, setUserAgent

Method Details

getDefaultWorkerLogLevel

@Enum("INFO")
DataflowWorkerLoggingOptions.Level getDefaultWorkerLogLevel()

Deprecated.

This option controls the default log level of all loggers without a log level override.

setDefaultWorkerLogLevel

void setDefaultWorkerLogLevel(DataflowWorkerLoggingOptions.Level level)

Deprecated.

getDefaultWorkerDirectLoggerLevel

@Enum("OFF")
DataflowWorkerLoggingOptions.Level getDefaultWorkerDirectLoggerLevel()

Deprecated.

Controls the log level for which messages are uploaded to Cloud Logging. If a message is configured to be sent to both directly to cloud logging and default disk-based logging it will just be sent to disk-based logging. This allows for configuration such as "--defaultWorkerLogLevel=WARN --defaultWorkerDirectLoggerLevel=INFO where INFO logs will be directly sent to cloud logging and WARN logs and higher will be sent to disk-based logging.

Note that this is just the default and may be overridden for specific classes with --workerDirectLogLevelOverrides.

setDefaultWorkerDirectLoggerLevel

void setDefaultWorkerDirectLoggerLevel(DataflowWorkerLoggingOptions.Level level)

Deprecated.

getWorkerDirectLoggerBufferByteLimit

@Long(104857600L)
Long getWorkerDirectLoggerBufferByteLimit()

Deprecated.

setWorkerDirectLoggerBufferByteLimit

void setWorkerDirectLoggerBufferByteLimit(Long value)

Deprecated.

getWorkerDirectLoggerBufferElementLimit

@Long(1000000L)
Long getWorkerDirectLoggerBufferElementLimit()

Deprecated.

setWorkerDirectLoggerBufferElementLimit

void setWorkerDirectLoggerBufferElementLimit(Long value)

Deprecated.

getWorkerSystemOutMessageLevel

@Enum("INFO")
DataflowWorkerLoggingOptions.Level getWorkerSystemOutMessageLevel()

Deprecated.

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.

setWorkerSystemOutMessageLevel

void setWorkerSystemOutMessageLevel(DataflowWorkerLoggingOptions.Level level)

Deprecated.

getWorkerSystemErrMessageLevel

@Enum("ERROR")
DataflowWorkerLoggingOptions.Level getWorkerSystemErrMessageLevel()

Deprecated.

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.

setWorkerSystemErrMessageLevel

void setWorkerSystemErrMessageLevel(DataflowWorkerLoggingOptions.Level level)

Deprecated.

getWorkerLogLevelOverrides

DataflowWorkerLoggingOptions.WorkerLogLevelOverrides getWorkerLogLevelOverrides()

Deprecated.

This option controls the log levels for specifically named loggers.

Later options with equivalent names override earlier options.

See DataflowWorkerLoggingOptions.WorkerLogLevelOverrides for more information on how to configure logging on a per Class, Package, or name basis. If used from the command line, the expected format is {"Name":"Level",...}, further details on DataflowWorkerLoggingOptions.WorkerLogLevelOverrides.from(java.util.Map<java.lang.String, java.lang.String>).

setWorkerLogLevelOverrides

void setWorkerLogLevelOverrides(DataflowWorkerLoggingOptions.WorkerLogLevelOverrides value)

Deprecated.

getWorkerDirectLogLevelOverrides

DataflowWorkerLoggingOptions.WorkerLogLevelOverrides getWorkerDirectLogLevelOverrides()

Deprecated.

This option controls the direct log levels for specifically named loggers. If a message is configured to be sent to both directly to cloud logging and default disk-based logging it will just be sent to disk-based logging. If an override only exists for a logger for direct logging, the --defaultWorkerLogLevel will be used for the non-direct configuration for the logger.

Later options with equivalent names override earlier options.

See DataflowWorkerLoggingOptions.WorkerLogLevelOverrides for more information on how to configure logging on a per Class, Package, or name basis. If used from the command line, the expected format is {"Name":"Level",...}, further details on DataflowWorkerLoggingOptions.WorkerLogLevelOverrides.from(java.util.Map<java.lang.String, java.lang.String>).

setWorkerDirectLogLevelOverrides

void setWorkerDirectLogLevelOverrides(DataflowWorkerLoggingOptions.WorkerLogLevelOverrides value)

Deprecated.

getDirectLoggingFallbackToDiskOnErrors

@Boolean(true)
Boolean getDirectLoggingFallbackToDiskOnErrors()

Deprecated.

setDirectLoggingFallbackToDiskOnErrors

void setDirectLoggingFallbackToDiskOnErrors(Boolean value)

Deprecated.

getDirectLoggingCooldownSeconds

@Integer(10)
Integer getDirectLoggingCooldownSeconds()

Deprecated.

setDirectLoggingCooldownSeconds

void setDirectLoggingCooldownSeconds(Integer value)

Deprecated.