LoggingRoot
Logging Root
- class DIRAC.FrameworkSystem.private.standardLogging.LoggingRoot.LoggingRoot(*args, **kwargs)
Bases:
DIRAC.FrameworkSystem.private.standardLogging.Logging.LoggingLoggingRoot is a particular Logging object: the first parent of the chain.
It is the one that initializes the root logger of the standard logging library and it configures it
As it defines the default behaviour of the Logging objects, it needs a specific class
It is unique, there is one and only one parent at the top of the chain: this justifies the usage of a Singleton
- class LocalSubLogger(logger: DIRAC.FrameworkSystem.private.standardLogging.Logging.Logging, extra: dict)
Bases:
objectThis is inspired from the standard LoggingAdapter. The idea is to provide an interface which looks like a Logger, but does not implement all the features. You can basically just create it, and log messages. You cannot create subLogger from it
This is to be used for very short lived sub logger. It allows to give context information (like a jobID) without creating a new logging object, which ends up eating all the memory (see https://github.com/DIRACGrid/DIRAC/issues/5280)
- __init__(logger: DIRAC.FrameworkSystem.private.standardLogging.Logging.Logging, extra: dict)
- Parameters
logger –
Loggingobject on which to be basedextra – dictionary of extra information to be passed
- __init__()
Initialization of the LoggingRoot object. LoggingRoot :
initialize the UTC time
set the correct level defines by the user, or the default
add the custom level to logging: verbose, notice, always
register a default backend (stdout): all messages will be displayed here
update the format according to the command line argument
- disableLogsFromExternalLibs()
Disable the display of the logs coming from external libraries
Warning
This method should only be used for debugging purposes.
- enableLogsFromExternalLibs()
Enable the display of the logs coming from external libraries
Warning
This method should only be used for debugging purposes.
- exception(sMsg: str = '', sVarMsg: str = '', lException: bool = False, lExcInfo: bool = False) bool
Exception level
- getDisplayOptions() dict[str, bool]
- Returns
the dictionary of the display options and their values. Must not be redefined
- getLocalSubLogger(subName: str) DIRAC.FrameworkSystem.private.standardLogging.Logging.Logging.LocalSubLogger
Create a subLogger which is meant to have very short lifetime, (e.g. when you want to add the jobID in the name)
Warning
This is a light version of a logger, read the documentation of
LocalSubLoggercarefully- Parameters
subName (str) – name of the child Logging
- getSubLogger(subName: str) DIRAC.FrameworkSystem.private.standardLogging.Logging.Logging
Create a new Logging object, child of this Logging, if it does not exists.
Warning
For very short lived sub logger, consider
getLocalSubLogger()instead- Parameters
subName (str) – name of the child Logging
- initialize(systemName: str, cfgPath: str, forceInit: bool = False)
Configure the root Logging. It can be possible to:
attach some backends to it: LogBackends = stdout,stderr,file,server
attach backend options: BackendOptions { FileName = /tmp/file.log }
attach filters to it and to some backends: see LogFilters
add colors: LogColor = True
precise a level: LogLevel = DEBUG
- instance = <DIRAC.FrameworkSystem.private.standardLogging.LoggingRoot.LoggingRoot object>
- registerBackend(desiredBackend: str, backendOptions: dict | None = None, backendFilters: dict | None = None) bool
Attach a backend to the Logging object. Convert backend name to backend class name to a Backend object and add it to the Logging object
- Parameters
desiredBackend – a name attaching to a backend type. List of possible values: [‘stdout’, ‘stderr’, ‘file’]
backendOptions – dictionary of different backend options. Example: FileName=’/tmp/log.txt’
backendFilters – dictionary of different backend filters. Example: {‘ModuleFilter’: {‘dirac’: ‘ERROR’}}
- Returns
Success or failure of registration
- Return type
- setLevel(levelName: str) bool
Check if the level name exists and set it.
- Parameters
levelName – string representing the level to give to the logger
- Returns
boolean representing if the setting is done or not
- showContexts(yesno: bool = True)
Depending on the value, display or not the context of the message. Make sure to enable the headers: showHeaders(True) before
- Parameters
yesno (bool) – determine the log record format
- showHeaders(yesno: bool = True)
Depending on the value, display or not the prefix of the message.
- Parameters
yesno (bool) – determine the log record format
- showStack() bool
Display a debug message without any content.
- Returns
boolean, True if the message is sent, else False
- showThreadIDs(yesno: bool = True)
Depending on the value, display or not the thread ID. Make sure to enable the headers: showHeaders(True) before
- Parameters
yesno (bool) – determe the log record format
- showTimeStamps(yesno: bool = True)
Depending on the value, display or not the timestamp of the message. Make sure to enable the headers: showHeaders(True) before
- Parameters
yesno (bool) – determine the log record format