Information (Enums)

EnumLogLevel
0OFF
1ERROR
2WARN
3INFO
4DEBUG
5TRACE
EnumComponentID
1JAVA
2NATIVE
3PY_PLANTA_DE
4PY_PLANTA_CH
5PY_CUSTOMER
6WEBSERVICE

Functions

log_enabled( level, cid, scope_suffix)

True, if logging is enabled for this log level in the logger specified by cid and scope_suffix

ParametersTypeDescription
loglevelIntegerEnum LogLevel
cidIntegerEnum ComponentID
scope_suffixStringnamespace
Return type:Boolean

log_write( loglevel, cid, fqn, id, marker, location_spec, message)

log_write () sends the message message with the given log level to the identified via scope_suffix logger. A component id is specified with cid. A log id enables the identification of the object, -1 will disable this. location_spec with the origin of the message can be specified more exactly.

ParameterTypDescription
levelIntegerLogLevel Enum
cidIntegerEnum ComponentID
fqnStringFully qualified name, e.g. module path
idInteger
markerString
location_specStringextra information for the location
messageString

add_marker_ref( marker, ref)

 Add a reference to another marker

ParametersType
markerString
refString

remove_marker_ref( marker, ref)

Remove a marker reference

ParametersType
markerString
refString

mdc_put( key, value)

Put a diagnostic context value (the val parameter) as identified with the key parameter into the current thread’s diagnostic context map. The key parameter cannot be null. The val parameter can only be null if the underlying implementation supports it. This method delegates all work to the MDC of the underlying logging system.  

ParametersType
keyString
valueString

mdc_get( key)

Get the diagnostic context identified by the key parameter. The key parameter cannot be null. This method delegates all work to the MDC of the underlying logging system.

ParametersType
keyString
Return type:String

mdc_remove( key)

Remove the diagnostic context identified by the key parameter using the underlying system’s MDC implementation. The key parameter cannot be null. This method does nothing if there is no previous value associated with key.

ParametersType
keyString

mdc_clear()

Clear all entries in the MDC of the underlying implementation

load_default_configuration()

Load the default configuration (config/logback.xml)

load_configuration( filename)

Load the configuration specified by filename

ParametersType
filenameString