Planta Logging

Information (Enums)

Enum LogLevel
0 OFF
1 ERROR
2 WARN
3 INFO
4 DEBUG
5 TRACE

Enum ComponentID
1 JAVA
2 NATIVE
3 PY_PLANTA_DE
4 PY_PLANTA_CH
5 PY_CUSTOMER
6 WEBSERVICE

Functions

log_enabled( level, cid, scope_suffix)

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

Parameters Type Description
loglevel Integer Enum LogLevel
cid Integer Enum ComponentID
scope_suffix String namespace
Return type: Boolean

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

log_write () sends the message message with the given loglevel 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 exatly

Parameter Typ Description
level Integer LogLevel Enum
cid Integer Enum ComponentID
fqn String Fully qualified name , e.g. module path
id Integer
marker String
location_spec String extra information for the location
message String

add_marker_ref( marker, ref)

Add a reference to another Marker

Parameters Type
marker String
ref String

remove_marker_ref( marker, ref)

Remove a marker reference

Parameters Type
marker String
ref String

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 be null only if the underlying implementation supports it. This method delegates all work to the MDC of the underlying logging system.

Parameters Type
key String
value String

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.

Parameters Type
key String
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.

Parameters Type
key String

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

Parameters Type
filename String

Topic revision: r8 - 2017-05-23 - 12:49:33 - StefanHeld
Current.PlantaLogging moved from Current.PythonLogging on 2014-02-12 - 17:30 by YusufAzal - put it back








 
  • Suche in Topic-Namen

  • Suche in Topic-Inhalten