BaseFormatter

BaseFormatter

class DIRAC.FrameworkSystem.private.standardLogging.Formatter.BaseFormatter.BaseFormatter(fmt=None, datefmt=None)

Bases: Formatter

BaseFormatter is used to format log record to create a string representing a DIRAC log message. It is based on the Formatter object of the standard ‘logging’ library.

The purpose of this Formatter is only to add a new parameter in the Formatter constructor: options. Indeed, all the custom Formatter objects of DIRAC will inherit from it to have this attribute because it is a dictionary containing DIRAC specific options useful to create new format.

__init__(fmt=None, datefmt=None)

Initialize the formatter without using parameters. They are then modified in format()

Parameters:

• fmt (str) – log format: “%(asctime)s UTC %(name)s %(levelname)s: %(message)”

• datefmt (str) – date format: “%Y-%m-%d %H:%M:%S”

converter()

gmtime([seconds]) -> (tm_year, tm_mon, tm_mday, tm_hour, tm_min,

tm_sec, tm_wday, tm_yday, tm_isdst)

Convert seconds since the Epoch to a time tuple expressing UTC (a.k.a. GMT). When ‘seconds’ is not passed in, convert the current time instead.

If the platform supports the tm_gmtoff and tm_zone, they are available as attributes only.

default_msec_format = '%s,%03d'

default_time_format = '%Y-%m-%d %H:%M:%S'

format(record)

Overriding. format is the main method of the Formatter object because it is the method which transforms a log record into a string. The format and the dateformat are hardcoded to return a DIRAC log format

Parameters:

record – the log record containing all the information about the log message: name, level, threadid…

formatException(ei)

Format and return the specified exception information as a string.

This default implementation just uses traceback.print_exception()

formatMessage(record)

formatStack(stack_info)

This method is provided as an extension point for specialized formatting of stack information.

The input data is a string as returned from a call to traceback.print_stack(), but with the last trailing newline removed.

The base implementation just returns the value passed in.

formatTime(record, datefmt=None)

Return the creation time of the specified LogRecord as formatted text.

This method should be called from format() by a formatter which wants to make use of a formatted time. This method can be overridden in formatters to provide for any specific requirement, but the basic behaviour is as follows: if datefmt (a string) is specified, it is used with time.strftime() to format the creation time of the record. Otherwise, an ISO8601-like (or RFC 3339-like) format is used. The resulting string is returned. This function uses a user-configurable function to convert the creation time to a tuple. By default, time.localtime() is used; to change this for a particular formatter instance, set the ‘converter’ attribute to a function with the same signature as time.localtime() or time.gmtime(). To change it for all formatters, for example if you want all logging times to be shown in GMT, set the ‘converter’ attribute in the Formatter class.

usesTime()

Check if the format uses the creation time of the record.