ncs.log Module

This module provides some logging utilities.

Functions

init_logging

init_logging(vmid, log_file, log_level)

Initialize logging

log_datefmt

log_datefmt()

Return date format used in logging.

log_file

log_file()

Return log file used, if any else None

log_format

log_format()

Return log format.

log_handler

log_handler()

Return log handler used, if any else None

mk_log_formatter

mk_log_formatter()

Create log formatter with log and date format setup

reopen_logs

reopen_logs()

Re-open log files if log handler is set

set_log_level

set_log_level(vmid, log_level)

Set log level on the vmid logger and root logger

Classes

class Log

A log helper class.

This class makes it easier to write log entries. It encapsulates another log object that supports Python standard log interface, and makes it easier to format the log message be adding the ability to support multiple arguments.

Example use:

import logging
import confd.log

logger = logging.getLogger(__name__)
mylog = confd.log.Log(logger)

count = 3
name = 'foo'
mylog.debug('got ', count, ' values from ', name)

Log(logobject, add_timestamp=False)

Initialize a Log object.

The argument 'logobject' is mandatory and can be any object which should support as least one of the standard log methods (info, warning, error, critical, debug). If 'add_timestamp' is set to True a time stamp will precede your log message.

Members:

critical(...)

Method:

critical(self, *args)

Log a critical message.

debug(...)

Method:

debug(self, *args)

Log a debug message.

error(...)

Method:

error(self, *args)

Log an error message.

exception(...)

Method:

exception(self, *args)

Log an exception message.

fatal(...)

Method:

fatal(self, *args)

Just calls critical().

info(...)

Method:

info(self, *args)

Log an information message.

warning(...)

Method:

warning(self, *args)

Log a warning message.

class ParentProcessLogHandler

ParentProcessLogHandler(log_q)

Members:

acquire(...)

Method:

acquire(self)

Acquire the I/O thread lock.

addFilter(...)

Method:

addFilter(self, filter)

Add the specified filter to this handler.

close(...)

Method:

close(self)

Tidy up any resources used by the handler.

This version removes the handler from an internal map of handlers, _handlers, which is used for handler lookup by name. Subclasses should ensure that this gets called from overridden close() methods.

createLock(...)

Method:

createLock(self)

Acquire a thread lock for serializing access to the underlying I/O.

emit(...)

Method:

emit(self, record)

Emit log record by sending a pre-formatted record to the parent process

filter(...)

Method:

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 by returning a false value. If a filter attached to a handler returns a log record instance, then that instance is used in place of the original log record in any further processing of the event by that handler. If a filter returns any other true value, the original log record is used in any further processing of the event by that handler.

If none of the filters return false values, this method returns a log record. If any of the filters return a false value, this method returns a false value.

.. versionchanged:: 3.2

Allow filters to be just callables.

.. versionchanged:: 3.12 Allow filters to return a LogRecord instead of modifying it in place.

flush(...)

Method:

flush(self)

Flushes the stream.

format(...)

Method:

format(self, record)

Format the specified record.

If a formatter is set, use it. Otherwise, use the default formatter for the module.

get_name(...)

Method:

get_name(self)

handle(...)

Method:

handle(self, record)

Conditionally emit the specified logging record.

Emission depends on filters which may have been added to the handler. Wrap the actual emission of the record with acquisition/release of the I/O thread lock.

Returns an instance of the log record that was emitted if it passed all filters, otherwise a false value is returned.

handleError(...)

Method:

handleError(self, record)

Handle errors which occur during an emit() call.

This method should be called from handlers when an exception is encountered during an emit() call. If raiseExceptions is false, exceptions get silently ignored. This is what is mostly wanted for a logging system - most users will not care about errors in the logging system, they are more interested in application errors. You could, however, replace this with a custom handler if you wish. The record which was being processed is passed in to this method.

name

release(...)

Method:

release(self)

Release the I/O thread lock.

removeFilter(...)

Method:

removeFilter(self, filter)

Remove the specified filter from this handler.

setFormatter(...)

Method:

setFormatter(self, fmt)

Set the formatter for this handler.

setLevel(...)

Method:

setLevel(self, level)

Set the logging level of this handler. level must be an int or a str.

setStream(...)

Method:

setStream(self, stream)

Sets the StreamHandler's stream to the specified value, if it is different.

Returns the old stream, if the stream was changed, or None if it wasn't.

set_name(...)

Method:

set_name(self, name)

terminator

terminator = '\n'