f5sdk.logger module¶
Python module for logging
Example - Basic:
from f5sdk.logger import Logger
logger = Logger(__name__).get_logger()
Example - Log level set using environment variable:
# export F5_SDK_LOG_LEVEL='INFO'
-
class
f5sdk.logger.
Logger
(name, **kwargs)¶ Class initialization
This class is a simple wrapper around the built-in logging module functionality.
-
name
¶ the logger name
- Type
str
-
level
¶ the logging level to use, such as ERROR, WARNING, INFO or DEBUG
- Type
str
-
get_logger
()¶ Refer to method documentation
Notes
The built-in logging module returns a pointer if the ‘named’ logger exists
-
get_logger
() Get Logger
- Parameters
None –
- Returns
instantiated logger
- Return type
object
-
-
class
f5sdk.logger.
MyLogger
(name, level=0)¶ Create custom logger class
-
addFilter
(filter)¶ Add the specified filter to this handler.
-
addHandler
(hdlr)¶ Add the specified handler to this logger.
-
callHandlers
(record)¶ Pass a record to all relevant handlers.
Loop through all handlers for this logger and its parents in the logger hierarchy. If no handler was found, output a one-off error message to sys.stderr. Stop searching up the hierarchy whenever a logger with the “propagate” attribute set to zero is found - that will be the last logger whose handlers are called.
-
critical
(msg, *args, **kwargs)¶ Log ‘msg % args’ with severity ‘CRITICAL’.
To pass exception information, use the keyword argument exc_info with a true value, e.g.
logger.critical(“Houston, we have a %s”, “major disaster”, exc_info=1)
-
debug
(msg, *args, **kwargs)¶ Log ‘msg % args’ with severity ‘DEBUG’.
To pass exception information, use the keyword argument exc_info with a true value, e.g.
logger.debug(“Houston, we have a %s”, “thorny problem”, exc_info=1)
-
error
(msg, *args, **kwargs)¶ Log ‘msg % args’ with severity ‘ERROR’.
To pass exception information, use the keyword argument exc_info with a true value, e.g.
logger.error(“Houston, we have a %s”, “major problem”, exc_info=1)
-
exception
(msg, *args, exc_info=True, **kwargs)¶ Convenience method for logging an ERROR with exception information.
-
fatal
(msg, *args, **kwargs)¶ Log ‘msg % args’ with severity ‘CRITICAL’.
To pass exception information, use the keyword argument exc_info with a true value, e.g.
logger.critical(“Houston, we have a %s”, “major disaster”, exc_info=1)
-
filter
(record)¶ Determine if a record is loggable by consulting all the filters.
The default is to allow the record to be logged; any filter can veto this and the record is then dropped. Returns a zero value if a record is to be dropped, else non-zero.
Changed in version 3.2: Allow filters to be just callables.
-
findCaller
(stack_info=False)¶ Find the stack frame of the caller so that we can note the source file name, line number and function name.
-
getChild
(suffix)¶ Get a logger which is a descendant to this one.
This is a convenience method, such that
logging.getLogger(‘abc’).getChild(‘def.ghi’)
is the same as
logging.getLogger(‘abc.def.ghi’)
It’s useful, for example, when the parent logger is named using __name__ rather than a literal string.
-
getEffectiveLevel
()¶ Get the effective level for this logger.
Loop through this logger and its parents in the logger hierarchy, looking for a non-zero logging level. Return the first one found.
-
handle
(record)¶ Call the handlers for the specified record.
This method is used for unpickled records received from a socket, as well as those created locally. Logger-level filtering is applied.
-
hasHandlers
()¶ See if this logger has any handlers configured.
Loop through all handlers for this logger and its parents in the logger hierarchy. Return True if a handler was found, else False. Stop searching up the hierarchy whenever a logger with the “propagate” attribute set to zero is found - that will be the last logger which is checked for the existence of handlers.
-
info
(msg, *args, **kwargs)¶ Log ‘msg % args’ with severity ‘INFO’.
To pass exception information, use the keyword argument exc_info with a true value, e.g.
logger.info(“Houston, we have a %s”, “interesting problem”, exc_info=1)
-
isEnabledFor
(level)¶ Is this logger enabled for level ‘level’?
-
log
(level, msg, *args, **kwargs)¶ Log ‘msg % args’ with the integer severity ‘level’.
To pass exception information, use the keyword argument exc_info with a true value, e.g.
logger.log(level, “We have a %s”, “mysterious problem”, exc_info=1)
-
makeRecord
(name, level, fn, lno, msg, args, exc_info, func=None, extra=None, sinfo=None)¶ A factory method which can be overridden in subclasses to create specialized LogRecords.
-
manager
= <logging.Manager object>¶
-
removeFilter
(filter)¶ Remove the specified filter from this handler.
-
removeHandler
(hdlr)¶ Remove the specified handler from this logger.
-
root
= <RootLogger root (WARNING)>¶
-
setLevel
(level)¶ Set the logging level of this logger. level must be an int or a str.
-
trace
(msg, *args, **kwargs)¶ Add trace method to logger
-
warn
(msg, *args, **kwargs)¶
-
warning
(msg, *args, **kwargs)¶ Log ‘msg % args’ with severity ‘WARNING’.
To pass exception information, use the keyword argument exc_info with a true value, e.g.
logger.warning(“Houston, we have a %s”, “bit of a problem”, exc_info=1)
-