com.google.cloud.dataflow.sdk.options

Class DataflowWorkerLoggingOptions.WorkerLogLevelOverride

java.lang.Object

com.google.cloud.dataflow.sdk.options.DataflowWorkerLoggingOptions.WorkerLogLevelOverride

Enclosing interface:

DataflowWorkerLoggingOptions

public static class DataflowWorkerLoggingOptions.WorkerLogLevelOverride
extends Object

Defines a log level override for a specific class, package, or name.

java.util.logging is used on the Dataflow worker harness and supports a logging hierarchy based off of names that are "." separated. It is a common pattern to have the logger for a given class share the same name as the class itself. Given the classes a.b.c.Foo, a.b.c.Xyz, and a.b.Bar, with loggers named "a.b.c.Foo", "a.b.c.Xyz", and "a.b.Bar" respectively, we can override the log levels:

• for Foo by specifying the name "a.b.c.Foo" or the Class representing a.b.c.Foo.
• for Foo, Xyz, and Bar by specifying the name "a.b" or the Package representing a.b.
• for Foo and Bar by specifying both of their names or classes.

Note that by specifying multiple overrides, the exact name followed by the closest parent takes precedence.

Method Summary

Modifier and Type	Method and Description
static DataflowWorkerLoggingOptions.WorkerLogLevelOverride	create(String value) Expects a value of the form Name#Level.
static DataflowWorkerLoggingOptions.WorkerLogLevelOverride	forClass(Class<?> klass, DataflowWorkerLoggingOptions.Level level) Overrides the default log level for the passed in class.
static DataflowWorkerLoggingOptions.WorkerLogLevelOverride	forName(String name, DataflowWorkerLoggingOptions.Level level) Overrides the default log level for the passed in name.
static DataflowWorkerLoggingOptions.WorkerLogLevelOverride	forPackage(Package pkg, DataflowWorkerLoggingOptions.Level level) Overrides the default log level for the passed in package.
DataflowWorkerLoggingOptions.Level	getLevel()
String	getName()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

forClass

public static DataflowWorkerLoggingOptions.WorkerLogLevelOverride forClass(Class<?> klass,
                                                                           DataflowWorkerLoggingOptions.Level level)

Overrides the default log level for the passed in class.

This is equivalent to calling forName(String, DataflowWorkerLoggingOptions.Level) and passing in the class name.

forPackage

public static DataflowWorkerLoggingOptions.WorkerLogLevelOverride forPackage(Package pkg,
                                                                             DataflowWorkerLoggingOptions.Level level)

Overrides the default log level for the passed in package.

This is equivalent to calling forName(String, DataflowWorkerLoggingOptions.Level) and passing in the package name.

forName

public static DataflowWorkerLoggingOptions.WorkerLogLevelOverride forName(String name,
                                                                          DataflowWorkerLoggingOptions.Level level)

Overrides the default log level for the passed in name.

Note that because of the hierarchical nature of logger names, this will override the log level of all loggers that have the passed in name or a parent logger that has the passed in name.

create

public static DataflowWorkerLoggingOptions.WorkerLogLevelOverride create(String value)

Expects a value of the form Name#Level. The Name generally represents the fully qualified Java class name, or fully qualified Java package name, or custom logger name. The Level represents the log level and must be one of DataflowWorkerLoggingOptions.Level.

getName

public String getName()

getLevel

public DataflowWorkerLoggingOptions.Level getLevel()

toString

public String toString()

Overrides:

toString in class Object