opmonlib.utils.LoggingFormatter Class Reference

Inheritance diagram for opmonlib.utils.LoggingFormatter:

Collaboration diagram for opmonlib.utils.LoggingFormatter:

Public Member Functions
None	__init__ (self, str fmt=full_log_format, str datefmt=date_time_format, tzinfo tz=time_zone)
str	formatTime (self, logging.LogRecord record, str datefmt)
logging.LogRecord	format (self, logging.LogRecord record)

Public Attributes
	tz = tz
	datefmt = datefmt

Detailed Description

Custom logging formatter for DUNE DAQ applications.

Definition at line 88 of file utils.py.

Constructor & Destructor Documentation

__init__()

None opmonlib.utils.LoggingFormatter.__init__	(		self,
		str	fmt = full_log_format,
		str	datefmt = date_time_format,
		tzinfo	tz = time_zone )

Construct the logging formatter.

Definition at line 91 of file utils.py.

    ) -> None:
        """Construct the logging formatter."""
        super().__init__(fmt, datefmt)
        self.tz = tz
        self.datefmt = datefmt
 

Member Function Documentation

format()

logging.LogRecord opmonlib.utils.LoggingFormatter.format	(		self,
		logging.LogRecord	record )

Apply the correct formatting to the log record.

Definition at line 107 of file utils.py.

    def format(self, record: logging.LogRecord) -> logging.LogRecord:
        """Apply the correct formatting to the log record."""
        record.asctime = self.formatTime(record, self.datefmt)
        # TODO: for production, remove filename and lineno entries
        component_width = 30
        file_lineno = f"{record.filename}:{record.lineno}"
        record.filename = file_lineno.ljust(component_width)[:component_width]
        component_width = 45
        name_colon = f"{record.name}:"
        if name_colon.startswith("drunc."):
            name_colon = name_colon.replace("drunc.", "")
        record.name = name_colon.ljust(component_width)[:component_width]
        component_width = 10
        level_name = record.levelname
        record.levelname = level_name.ljust(component_width)[:component_width]
        return super().format(record)
 
 

formatTime()

str opmonlib.utils.LoggingFormatter.formatTime	(		self,
		logging.LogRecord	record,
		str	datefmt )

Apply the correct formatting to the log record date and time.

Definition at line 102 of file utils.py.

    def formatTime(self, record: logging.LogRecord, datefmt: str) -> str:  # noqa: N802
        """Apply the correct formatting to the log record date and time."""
        date_time = datetime.fromtimestamp(record.created, self.tz)
        return date_time.strftime(self.datefmt)
 

Member Data Documentation

datefmt

opmonlib.utils.LoggingFormatter.datefmt = datefmt

Definition at line 100 of file utils.py.

tz

opmonlib.utils.LoggingFormatter.tz = tz

Definition at line 99 of file utils.py.

---

The documentation for this class was generated from the following file:

• /github/workspace/dunedaq/sourcecode/opmonlib/python/opmonlib/utils.py