org.apache.beam.runners.dataflow.options

Interface DataflowWorkerLoggingOptions

All Superinterfaces:

HasDisplayData, PipelineOptions

All Known Subinterfaces:

DataflowPipelineOptions, DataflowWorkerHarnessOptions, TestDataflowPipelineOptions

public interface DataflowWorkerLoggingOptions
extends PipelineOptions

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DataflowWorkerLoggingOptions.Level The set of log levels that can be used on the Dataflow worker.
static class	DataflowWorkerLoggingOptions.WorkerLogLevelOverrides 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 and Description
DataflowWorkerLoggingOptions.Level	getDefaultWorkerLogLevel() This option controls the default log level of all loggers without a log level override.
DataflowWorkerLoggingOptions.WorkerLogLevelOverrides	getWorkerLogLevelOverrides() This option controls the log levels for specifically named loggers.
DataflowWorkerLoggingOptions.Level	getWorkerSystemErrMessageLevel() Controls the log level given to messages printed to System.err.
DataflowWorkerLoggingOptions.Level	getWorkerSystemOutMessageLevel() Controls the log level given to messages printed to System.out.
void	setDefaultWorkerLogLevel(DataflowWorkerLoggingOptions.Level level)
void	setWorkerLogLevelOverrides(DataflowWorkerLoggingOptions.WorkerLogLevelOverrides value)
void	setWorkerSystemErrMessageLevel(DataflowWorkerLoggingOptions.Level level)
void	setWorkerSystemOutMessageLevel(DataflowWorkerLoggingOptions.Level level)

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

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

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

populateDisplayData

Method Detail

getDefaultWorkerLogLevel

@Default.Enum(value="INFO")
DataflowWorkerLoggingOptions.Level getDefaultWorkerLogLevel()

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

setDefaultWorkerLogLevel

void setDefaultWorkerLogLevel(DataflowWorkerLoggingOptions.Level level)

getWorkerSystemOutMessageLevel

@Default.Enum(value="INFO")
DataflowWorkerLoggingOptions.Level getWorkerSystemOutMessageLevel()

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)

getWorkerSystemErrMessageLevel

@Default.Enum(value="ERROR")
DataflowWorkerLoggingOptions.Level getWorkerSystemErrMessageLevel()

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)

getWorkerLogLevelOverrides

DataflowWorkerLoggingOptions.WorkerLogLevelOverrides getWorkerLogLevelOverrides()

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)