ColoredBaseFormatter

ColoredBaseFormatter

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

Bases: DIRAC.FrameworkSystem.private.standardLogging.Formatter.BaseFormatter.BaseFormatter

ColoredBaseFormatter is used to format log record to create a string representing a log message. It is based on the BaseFormatter object which is based on the of the standard logging library.

This custom formatter is useful for format messages to correspond with the gLogger format. It adds color on all messages which come from StdoutBackend and StderrBackend and color them according to their levels.

COLOR_MAP = {'black': 0, 'blue': 4, 'cyan': 6, 'green': 2, 'magenta': 5, 'red': 1, 'white': 7, 'yellow': 3}
LEVEL_MAP = {'ALWAYS': ('black', 'white', False), 'DEBUG': (None, 'blue', False), 'ERROR': (None, 'red', False), 'FATAL': ('red', 'black', False), 'INFO': (None, 'green', False), 'NOTICE': (None, 'magenta', False), 'VERBOSE': (None, 'cyan', False), 'WARN': (None, 'yellow', False)}
__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
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.

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 with colors. According to the level, the method get colors from LEVEL_MAP to add them to the message.

Params 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()

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.

usesTime()

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