| | |
- __builtin__.object
-
- LogThrottleAlarmerBase
- logging.Logger(logging.Filterer)
-
- Logger
class LogThrottleAlarmerBase(__builtin__.object) |
| |
Abstract base class for the LogThrottle to raise/clear alarms
|
| |
Methods defined here:
- sendThrottleAlarm(self, active)
- Send/Clear the alarm for the LogThrottle
Raise the alarm if active=True and clear otherwise
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __abstractmethods__ = frozenset(['sendThrottleAlarm'])
- __metaclass__ = <class 'abc.ABCMeta'>
- Metaclass for defining Abstract Base Classes (ABCs).
Use this metaclass to create an ABC. An ABC can be subclassed
directly, and then acts as a mix-in class. You can also register
unrelated concrete classes (even built-in classes) and unrelated
ABCs as 'virtual subclasses' -- these and their descendants will
be considered subclasses of the registering ABC by the built-in
issubclass() function, but the registering ABC won't show up in
their MRO (Method Resolution Order) nor will method
implementations defined by the registering ABC be callable (not
even via super()).
|
class Logger(logging.Logger) |
| |
Logger is of primary interest to developers. It is used to send log
messages to the ACS Logging System. Developers need not create an instance
of this class though as the getLogger() function returns a singled logger.
|
| |
- Method resolution order:
- Logger
- logging.Logger
- logging.Filterer
Methods defined here:
- __init__(self, name)
- Create a Logger instance.
Parameters: name of this logger
Returns: Nothing
Raises: Nothing
- configureLogging(self, maxLogsPerSec, alarmSender=None)
- If alarmSender is not None, it must be a subclass of LogThrottleAlarmerBase
See also ACSHandler.configureLogging
- findCaller(self)
- Find the stack frame of the caller so that we can note the source
file name, line number and function name.
- getLevels(self)
- Return the current priority level values for the stdout and central logs.
Parameter: None
Returns: Logging.LoggingConfigurable.LogLevels object containing the current level settings
Raises: Nothing
- logAlert(self, msg)
- Log an alert message.
Parameters:
- msg is a string to be sent to the logging system
Returns: Nothing
Raises: Nothing
- logAtLevel(self, lvl, msg)
- Log a message at the given level.
Parameters:
- lvl is the log level to send the message at
- msg is a string to be sent to the logging system
Returns: Nothing
Raises: ValueError if lvl is NOTSET or OFF
- logCritical(self, msg)
- Log a critical message.
Parameters:
- msg is a string to be sent to the logging system
Returns: Nothing
Raises: Nothing
- logDebug(self, msg)
- Log a debug message.
Parameters:
- msg is a string to be sent to the logging system
Returns: Nothing
Raises: Nothing
- logDelouse(self, msg)
- Log a delouse message.
Parameters:
- msg is a string to be sent to the logging system
Returns: Nothing
Raises: Nothing
- logEmergency(self, msg)
- Log an emergency message.
Parameters:
- msg is a string to be sent to the logging system
Returns: Nothing
Raises: Nothing
- logError(self, msg)
- Log an error message.
Parameters:
- msg is a string to be sent to the logging system
Returns: Nothing
Raises: Nothing
- logErrorTrace(self, errortrace, priority=ACS_LOG_ERROR)
- Log an error stack trace.
Parameter:
- errortrace (top of error stack)
- priorty value of logging priorty
Returns: Nothing
Raises: KeyError if priority is not in the ACSLog.Priorities
- logInfo(self, msg)
- Log an informational message.
Parameters:
- msg is a string to be sent to the logging system
Returns: Nothing
Raises: Nothing
- logNotSoTypeSafe(self, priority, msg, audience=None, array=None, antenna=None)
- Log a message indicating audience, array and/or antenna.
Parameter:
- priority value of logging priority
- msg log definition shortDescription
- audience
- array
- antenna
Returns: Nothing
Raises: KeyError if priority is not in the ACSLog.Priorities
- logNotice(self, msg)
- Log a notice message.
Parameters:
- msg is a string to be sent to the logging system
Returns: Nothing
Raises: Nothing
- logTrace(self, msg)
- Log a trace message.
Parameters:
- msg is a string to be sent to the logging system
Returns: Nothing
Raises: Nothing
- logTypeSafe(self, priority, timestamp, msg, rtCont, srcInfo, data, audience=None, array=None, antenna=None)
- Log a type safe log.
Parameter:
- priority value of logging priority
- timestamp time of log creation
- msg log definition shortDescription
- rtCont run-time context information
- srcInfo src information
- data name/value pairs
Returns: Nothing
Raises: KeyError if priority is not in the ACSLog.Priorities
- logWarning(self, msg)
- Log a warning message.
Parameters:
- msg is a string to be sent to the logging system
Returns: Nothing
Raises: Nothing
- logXML(self, xml)
- Log an XML string.
Parameter:
xml - XML string (really just any string, but the log server
may not like anything non-XMLish -- I have not
tried this)
Returns: Nothing
Raises: Nothing
- makeRecord(self, name, level, fn, lno, msg, args, exc_info, func=None, extra=None)
- Build the ACSLogRecord for this information
- setLevels(self, loglevel)
- Adjust the priority level filter for log messages.
Parameter:
- Logging.LoggingConfigurable.LogLevels object containing new level information
Returns: Nothing
Raises: Nothing
Methods inherited from logging.Logger:
- addHandler(self, hdlr)
- Add the specified handler to this logger.
- callHandlers(self, 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(self, 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(self, 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(self, 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(self, msg, *args)
- Convenience method for logging an ERROR with exception information.
- fatal = critical(self, 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)
- getEffectiveLevel(self)
- 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(self, 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.
- info(self, 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(self, level)
- Is this logger enabled for level 'level'?
- log(self, 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)
- removeHandler(self, hdlr)
- Remove the specified handler from this logger.
- setLevel(self, level)
- Set the logging level of this logger.
- warn = warning(self, 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)
- warning(self, 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)
Data and other attributes inherited from logging.Logger:
- manager = <logging.Manager instance>
- root = <logging.RootLogger instance>
Methods inherited from logging.Filterer:
- addFilter(self, filter)
- Add the specified filter to this handler.
- filter(self, 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.
- removeFilter(self, filter)
- Remove the specified filter from this handler.
| |