lsst.log.log.logContinued Namespace Reference

Classes
class	LevelTranslator
class	Log
class	LogHandler
class	MDCDict
class	UsePythonLogging

Functions
	configure (*args)
	configure_prop (properties)
	configure_pylog_MDC (str level, Optional[type] MDC_class=MDCDict)
	getDefaultLogger ()
	getLogger (loggername)
	MDC (key, value)
	MDCRemove (key)
	MDCRegisterInit (func)
	setLevel (loggername, level)
	getLevel (loggername)
	getEffectiveLevel (loggername)
	isEnabledFor (loggername, level)
	log (loggername, level, fmt, *args, **kwargs)
	trace (fmt, *args)
	debug (fmt, *args)
	info (fmt, *args)
	warn (fmt, *args)
	warning (fmt, *args)
	error (fmt, *args)
	fatal (fmt, *args)
	critical (fmt, *args)
	lwpID ()
	getLevelName (level)
	usePythonLogging ()
	doNotUsePythonLogging ()

Variables
int	TRACE = 5000
int	DEBUG = 10000
int	INFO = 20000
int	WARN = 30000
int	ERROR = 40000
int	FATAL = 50000
int	CRITICAL = FATAL
int	WARNING = WARN

Function Documentation

configure()

lsst.log.log.logContinued.configure

(

*

args

)

Definition at line 204 of file logContinued.py.

def configure(*args):
    Log.configure(*args)
 
 

configure_prop()

lsst.log.log.logContinued.configure_prop

(

properties

)

Definition at line 208 of file logContinued.py.

def configure_prop(properties):
    Log.configure_prop(properties)
 
 

configure_pylog_MDC()

lsst.log.log.logContinued.configure_pylog_MDC	(	str	level,
		Optional[type]	MDC_class = MDCDict )

Configure log4cxx to send messages to Python logging, with MDC support.

Parameters
----------
level : `str`
    Name of the logging level for root log4cxx logger.
MDC_class : `type`, optional
    Type of dictionary which is added to `logging.LogRecord` as an ``MDC``
    attribute. Any dictionary or ``defaultdict``-like class can be used as
    a type. If `None` the `logging.LogRecord` will not be augmented.

Notes
-----
This method does two things:

- Configures log4cxx with a given logging level and a ``PyLogAppender``
  appender class which forwards all messages to Python `logging`.
- Installs a record factory for Python `logging` that adds ``MDC``
  attribute to every `logging.LogRecord` object (instance of
  ``MDC_class``). This will happen by default but can be disabled
  by setting the ``MDC_class`` parameter to `None`.

Definition at line 212 of file logContinued.py.

def configure_pylog_MDC(level: str, MDC_class: Optional[type] = MDCDict):
    """Configure log4cxx to send messages to Python logging, with MDC support.
 
    Parameters
    ----------
    level : `str`
        Name of the logging level for root log4cxx logger.
    MDC_class : `type`, optional
        Type of dictionary which is added to `logging.LogRecord` as an ``MDC``
        attribute. Any dictionary or ``defaultdict``-like class can be used as
        a type. If `None` the `logging.LogRecord` will not be augmented.
 
    Notes
    -----
    This method does two things:
 
    - Configures log4cxx with a given logging level and a ``PyLogAppender``
      appender class which forwards all messages to Python `logging`.
    - Installs a record factory for Python `logging` that adds ``MDC``
      attribute to every `logging.LogRecord` object (instance of
      ``MDC_class``). This will happen by default but can be disabled
      by setting the ``MDC_class`` parameter to `None`.
    """
    if MDC_class is not None:
        old_factory = logging.getLogRecordFactory()
 
        def record_factory(*args, **kwargs):
            record = old_factory(*args, **kwargs)
            record.MDC = MDC_class()
            return record
 
        logging.setLogRecordFactory(record_factory)
 
    properties = f"""\
log4j.rootLogger = {level}, PyLog
log4j.appender.PyLog = PyLogAppender
"""
    configure_prop(properties)
 
 

critical()

lsst.log.log.logContinued.critical	(		fmt,
		*	args )

Definition at line 323 of file logContinued.py.

def critical(fmt, *args):
    fatal(fmt, *args)
 
 

debug()

lsst.log.log.logContinued.debug	(		fmt,
		*	args )

Definition at line 299 of file logContinued.py.

def debug(fmt, *args):
    Log.getDefaultLogger()._log(DEBUG, False, fmt, *args)
 
 

doNotUsePythonLogging()

lsst.log.log.logContinued.doNotUsePythonLogging

(

)

Definition at line 352 of file logContinued.py.

def doNotUsePythonLogging():
    Log.doNotUsePythonLogging()
 
 

error()

lsst.log.log.logContinued.error	(		fmt,
		*	args )

Definition at line 315 of file logContinued.py.

def error(fmt, *args):
    Log.getDefaultLogger()._log(ERROR, False, fmt, *args)
 
 

fatal()

lsst.log.log.logContinued.fatal	(		fmt,
		*	args )

Definition at line 319 of file logContinued.py.

def fatal(fmt, *args):
    Log.getDefaultLogger()._log(FATAL, False, fmt, *args)
 
 

getDefaultLogger()

lsst.log.log.logContinued.getDefaultLogger

(

)

Definition at line 252 of file logContinued.py.

def getDefaultLogger():
    return Log.getDefaultLogger()
 
 

getEffectiveLevel()

lsst.log.log.logContinued.getEffectiveLevel

(

loggername

)

Definition at line 280 of file logContinued.py.

def getEffectiveLevel(loggername):
    return Log.getLogger(loggername).getEffectiveLevel()
 
 

getLevel()

lsst.log.log.logContinued.getLevel

(

loggername

)

Definition at line 276 of file logContinued.py.

def getLevel(loggername):
    return Log.getLogger(loggername).getLevel()
 
 

getLevelName()

lsst.log.log.logContinued.getLevelName

(

level

)

Return the name associated with this logging level.

Returns "Level %d" if no name can be found.

Definition at line 331 of file logContinued.py.

def getLevelName(level):
    """Return the name associated with this logging level.
 
    Returns "Level %d" if no name can be found.
    """
    names = ("DEBUG", "TRACE", "WARNING", "FATAL", "INFO", "ERROR")
    for name in names:
        test_level = getattr(Log, name)
        if test_level == level:
            return name
    return f"Level {level}"
 
 
# This will cause a warning in Sphinx documentation due to confusion between
# UsePythonLogging and usePythonLogging.
# https://github.com/astropy/sphinx-automodapi/issues/73 (but note that this
# does not seem to be Mac-only).

getLogger()

lsst.log.log.logContinued.getLogger

(

loggername

)

Definition at line 256 of file logContinued.py.

def getLogger(loggername):
    return Log.getLogger(loggername)
 
 

info()

lsst.log.log.logContinued.info	(		fmt,
		*	args )

Definition at line 303 of file logContinued.py.

def info(fmt, *args):
    Log.getDefaultLogger()._log(INFO, False, fmt, *args)
 
 

isEnabledFor()

lsst.log.log.logContinued.isEnabledFor	(		loggername,
			level )

Definition at line 284 of file logContinued.py.

def isEnabledFor(loggername, level):
    return Log.getLogger(loggername).isEnabledFor(level)
 
 
# This will cause a warning in Sphinx documentation due to confusion between
# Log and log. https://github.com/astropy/sphinx-automodapi/issues/73 (but
# note that this does not seem to be Mac-only).

log()

lsst.log.log.logContinued.log	(		loggername,
			level,
			fmt,
		*	args,
		**	kwargs )

Definition at line 291 of file logContinued.py.

def log(loggername, level, fmt, *args, **kwargs):
    Log.getLogger(loggername)._log(level, False, fmt, *args)
 
 

lwpID()

lsst.log.log.logContinued.lwpID

(

)

Definition at line 327 of file logContinued.py.

def lwpID():
    return Log.lwpID
 
 

MDC()

lsst.log.log.logContinued.MDC	(		key,
			value )

Definition at line 260 of file logContinued.py.

def MDC(key, value):
    return Log.MDC(key, str(value))
 
 

MDCRegisterInit()

lsst.log.log.logContinued.MDCRegisterInit

(

func

)

Definition at line 268 of file logContinued.py.

def MDCRegisterInit(func):
    Log.MDCRegisterInit(func)
 
 

MDCRemove()

lsst.log.log.logContinued.MDCRemove

(

key

)

Definition at line 264 of file logContinued.py.

def MDCRemove(key):
    Log.MDCRemove(key)
 
 

setLevel()

lsst.log.log.logContinued.setLevel	(		loggername,
			level )

Definition at line 272 of file logContinued.py.

def setLevel(loggername, level):
    Log.getLogger(loggername).setLevel(level)
 
 

trace()

lsst.log.log.logContinued.trace	(		fmt,
		*	args )

Definition at line 295 of file logContinued.py.

def trace(fmt, *args):
    Log.getDefaultLogger()._log(TRACE, False, fmt, *args)
 
 

usePythonLogging()

lsst.log.log.logContinued.usePythonLogging

(

)

Definition at line 348 of file logContinued.py.

def usePythonLogging():
    Log.usePythonLogging()
 
 

warn()

lsst.log.log.logContinued.warn	(		fmt,
		*	args )

Definition at line 307 of file logContinued.py.

def warn(fmt, *args):
    Log.getDefaultLogger()._log(WARN, False, fmt, *args)
 
 

warning()

lsst.log.log.logContinued.warning	(		fmt,
		*	args )

Definition at line 311 of file logContinued.py.

def warning(fmt, *args):
    warn(fmt, *args)
 
 

Variable Documentation

CRITICAL

int lsst.log.log.logContinued.CRITICAL = FATAL

Definition at line 51 of file logContinued.py.

DEBUG

int lsst.log.log.logContinued.DEBUG = 10000

Definition at line 44 of file logContinued.py.

ERROR

int lsst.log.log.logContinued.ERROR = 40000

Definition at line 47 of file logContinued.py.

FATAL

int lsst.log.log.logContinued.FATAL = 50000

Definition at line 48 of file logContinued.py.

INFO

int lsst.log.log.logContinued.INFO = 20000

Definition at line 45 of file logContinued.py.

TRACE

int lsst.log.log.logContinued.TRACE = 5000

Definition at line 43 of file logContinued.py.

WARN

int lsst.log.log.logContinued.WARN = 30000

Definition at line 46 of file logContinued.py.

WARNING

int lsst.log.log.logContinued.WARNING = WARN

Definition at line 52 of file logContinued.py.