From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id AC95AA00C2; Mon, 26 Sep 2022 16:17:41 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 4E57C4282D; Mon, 26 Sep 2022 16:17:25 +0200 (CEST) Received: from lb.pantheon.sk (lb.pantheon.sk [46.229.239.20]) by mails.dpdk.org (Postfix) with ESMTP id 5ED9E40DF7 for ; Mon, 26 Sep 2022 16:17:22 +0200 (CEST) Received: from localhost (localhost [127.0.0.1]) by lb.pantheon.sk (Postfix) with ESMTP id 9569B243CEE; Mon, 26 Sep 2022 16:17:21 +0200 (CEST) X-Virus-Scanned: amavisd-new at siecit.sk Received: from lb.pantheon.sk ([127.0.0.1]) by localhost (lb.pantheon.sk [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id dkyRZ2Oya6pq; Mon, 26 Sep 2022 16:17:20 +0200 (CEST) Received: from entguard.lab.pantheon.local (unknown [46.229.239.141]) by lb.pantheon.sk (Postfix) with ESMTP id F1C65243CF2; Mon, 26 Sep 2022 16:17:15 +0200 (CEST) From: =?UTF-8?q?Juraj=20Linke=C5=A1?= To: thomas@monjalon.net, david.marchand@redhat.com, Honnappa.Nagarahalli@arm.com, ohilyard@iol.unh.edu, lijuan.tu@intel.com, kda@semihalf.com, bruce.richardson@intel.com Cc: dev@dpdk.org, =?UTF-8?q?Juraj=20Linke=C5=A1?= Subject: [PATCH v5 04/10] dts: add basic logging facility Date: Mon, 26 Sep 2022 14:17:07 +0000 Message-Id: <20220926141713.2415010-5-juraj.linkes@pantheon.tech> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220926141713.2415010-1-juraj.linkes@pantheon.tech> References: <20220926141713.2415010-1-juraj.linkes@pantheon.tech> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org The logging module provides loggers distinguished by two attributes, a custom format and a verbosity switch. The loggers log to both console and more verbosely to files. Signed-off-by: Owen Hilyard Signed-off-by: Juraj Linkeš --- dts/framework/__init__.py | 4 ++ dts/framework/logger.py | 115 ++++++++++++++++++++++++++++++++++++++ dts/framework/settings.py | 12 ++++ 3 files changed, 131 insertions(+) create mode 100644 dts/framework/__init__.py create mode 100644 dts/framework/logger.py diff --git a/dts/framework/__init__.py b/dts/framework/__init__.py new file mode 100644 index 0000000000..6cdc0639db --- /dev/null +++ b/dts/framework/__init__.py @@ -0,0 +1,4 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2022 PANTHEON.tech s.r.o. +# Copyright(c) 2022 University of New Hampshire +# diff --git a/dts/framework/logger.py b/dts/framework/logger.py new file mode 100644 index 0000000000..6917006115 --- /dev/null +++ b/dts/framework/logger.py @@ -0,0 +1,115 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2010-2014 Intel Corporation +# Copyright(c) 2022 PANTHEON.tech s.r.o. +# Copyright(c) 2022 University of New Hampshire +# + +import logging +import os.path +from typing import TypedDict + +from .settings import SETTINGS + +""" +DTS logger module with several log level. DTS framework and TestSuite logs +are saved in different log files. +""" +date_fmt = "%Y/%m/%d %H:%M:%S" +stream_fmt = "%(asctime)s - %(name)s - %(levelname)s - %(message)s" + + +class LoggerDictType(TypedDict): + logger: "DTSLOG" + name: str + node: str + + +# List for saving all using loggers +global Loggers +Loggers: list[LoggerDictType] = [] + + +class DTSLOG(logging.LoggerAdapter): + """ + DTS log class for framework and testsuite. + """ + + node: str + logger: logging.Logger + sh: logging.StreamHandler + fh: logging.FileHandler + verbose_fh: logging.FileHandler + + def __init__(self, logger: logging.Logger, node: str = "suite"): + self.logger = logger + # 1 means log everything, this will be used by file handlers if their level + # is not set + self.logger.setLevel(1) + + self.node = node + + # add handler to emit to stdout + sh = logging.StreamHandler() + sh.setFormatter(logging.Formatter(stream_fmt, date_fmt)) + sh.setLevel(logging.INFO) # console handler default level + + if SETTINGS.verbose is True: + sh.setLevel(logging.DEBUG) + + self.logger.addHandler(sh) + self.sh = sh + + if not os.path.exists("output"): + os.mkdir("output") + + fh = logging.FileHandler(f"output/{node}.log") + fh.setFormatter( + logging.Formatter( + fmt="%(asctime)s - %(name)s - %(levelname)s - %(message)s", + datefmt=date_fmt, + ) + ) + + self.logger.addHandler(fh) + self.fh = fh + + # This outputs EVERYTHING, intended for post-mortem debugging + # Also optimized for processing via AWK (awk -F '|' ...) + verbose_fh = logging.FileHandler(f"output/{node}.verbose.log") + verbose_fh.setFormatter( + logging.Formatter( + fmt="%(asctime)s|%(name)s|%(levelname)s|%(pathname)s|%(lineno)d|" + "%(funcName)s|%(process)d|%(thread)d|%(threadName)s|%(message)s", + datefmt=date_fmt, + ) + ) + + self.logger.addHandler(verbose_fh) + self.verbose_fh = verbose_fh + + super(DTSLOG, self).__init__(self.logger, dict(node=self.node)) + + def logger_exit(self) -> None: + """ + Remove stream handler and logfile handler. + """ + for handler in (self.sh, self.fh, self.verbose_fh): + handler.flush() + self.logger.removeHandler(handler) + + +def getLogger(name: str, node: str = "suite") -> DTSLOG: + """ + Get logger handler and if there's no handler for specified Node will create one. + """ + global Loggers + # return saved logger + logger: LoggerDictType + for logger in Loggers: + if logger["name"] == name and logger["node"] == node: + return logger["logger"] + + # return new logger + dts_logger: DTSLOG = DTSLOG(logging.getLogger(name), node) + Loggers.append({"logger": dts_logger, "name": name, "node": node}) + return dts_logger diff --git a/dts/framework/settings.py b/dts/framework/settings.py index d1a955502b..ed43ba33a0 100644 --- a/dts/framework/settings.py +++ b/dts/framework/settings.py @@ -57,6 +57,7 @@ def __call__( @dataclass(slots=True, frozen=True) class _Settings: config_file_path: str + verbose: bool def _get_parser() -> argparse.ArgumentParser: @@ -71,6 +72,16 @@ def _get_parser() -> argparse.ArgumentParser: "and targets.", ) + parser.add_argument( + "-v", + "--verbose", + action=_env_arg("DTS_VERBOSE"), + default="N", + required=False, + help="[DTS_VERBOSE] Set to 'Y' to enable verbose output, logging all messages " + "to the console.", + ) + return parser @@ -78,6 +89,7 @@ def _get_settings() -> _Settings: parsed_args = _get_parser().parse_args() return _Settings( config_file_path=parsed_args.config_file, + verbose=(parsed_args.verbose == "Y"), ) -- 2.30.2