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

Bases: logging.Formatter

BaseFormatter is used to format log record to create a string representing a 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, datefmt, options)

Initialize the formatter with new arguments.

Params fmt:string representing the format: “%(asctime)s UTC %(name)s %(levelname)s: %(message)”
Params datefmt:string representing the date format: “%Y-%m-%d %H:%M:%S”
Params options:dictionary of logging DIRAC options
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.


Format the specified record as text.

The record’s attribute dictionary is used as the operand to a string formatting operation which yields the returned string. Before formatting the dictionary, a couple of preparatory steps are carried out. The message attribute of the record is computed using LogRecord.getMessage(). If the formatting string uses the time (as determined by a call to usesTime(), formatTime() is called to format the event time. If there is exception information, it is formatted using formatException() and appended to the message.


Format and return the specified exception information as a string.

This default implementation just uses traceback.print_exception()

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, the ISO8601 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.


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