Package org.apache.beam.sdk.options

Class SdkHarnessOptions.SdkHarnessLogLevelOverrides

java.lang.Object

java.util.AbstractMap<String,SdkHarnessOptions.LogLevel>

java.util.HashMap<String,SdkHarnessOptions.LogLevel>

org.apache.beam.sdk.options.SdkHarnessOptions.SdkHarnessLogLevelOverrides

All Implemented Interfaces:

Serializable, Cloneable, Map<String,SdkHarnessOptions.LogLevel>

Enclosing interface:

SdkHarnessOptions

public static class SdkHarnessOptions.SdkHarnessLogLevelOverrides
extends HashMap<String,SdkHarnessOptions.LogLevel>

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

The SDK harness 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.

System.out and System.err messages are configured via loggers of the corresponding name. Note that by specifying multiple overrides, the exact name followed by the closest parent takes precedence.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
SdkHarnessLogLevelOverrides()

Method Summary

Modifier and Type	Method	Description
SdkHarnessOptions.SdkHarnessLogLevelOverrides	addOverrideForClass(Class<?> klass, SdkHarnessOptions.LogLevel logLevel)	Overrides the default log level for the passed in class.
SdkHarnessOptions.SdkHarnessLogLevelOverrides	addOverrideForName(String name, SdkHarnessOptions.LogLevel logLevel)	Overrides the default log logLevel for the passed in name.
SdkHarnessOptions.SdkHarnessLogLevelOverrides	addOverrideForPackage(Package pkg, SdkHarnessOptions.LogLevel logLevel)	Overrides the default log level for the passed in package.
static SdkHarnessOptions.SdkHarnessLogLevelOverrides	from(Map<String,String> values)	Expects a map keyed by logger Names with values representing LogLevels.

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, newHashMap, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Details

SdkHarnessLogLevelOverrides

public SdkHarnessLogLevelOverrides()

Method Details

addOverrideForClass

public SdkHarnessOptions.SdkHarnessLogLevelOverrides addOverrideForClass(Class<?> klass,
 SdkHarnessOptions.LogLevel logLevel)

Overrides the default log level for the passed in class.

This is equivalent to calling addOverrideForName(String, LogLevel) and passing in the class name.

addOverrideForPackage

public SdkHarnessOptions.SdkHarnessLogLevelOverrides addOverrideForPackage(Package pkg,
 SdkHarnessOptions.LogLevel logLevel)

Overrides the default log level for the passed in package.

This is equivalent to calling addOverrideForName(String, LogLevel) and passing in the package name.

addOverrideForName

public SdkHarnessOptions.SdkHarnessLogLevelOverrides addOverrideForName(String name,
 SdkHarnessOptions.LogLevel logLevel)

Overrides the default log logLevel for the passed in name.

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

from

public static SdkHarnessOptions.SdkHarnessLogLevelOverrides from(Map<String,String> values)

Expects a map keyed by logger Names with values representing LogLevels. The Name generally represents the fully qualified Java class name, or fully qualified Java package name, or custom logger name. The LogLevel represents the log level and must be one of SdkHarnessOptions.LogLevel.