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 59B7843F5D; Wed, 1 May 2024 18:17:41 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 698F340633; Wed, 1 May 2024 18:17:33 +0200 (CEST) Received: from mail-qv1-f97.google.com (mail-qv1-f97.google.com [209.85.219.97]) by mails.dpdk.org (Postfix) with ESMTP id C5472402A7 for ; Wed, 1 May 2024 18:17:31 +0200 (CEST) Received: by mail-qv1-f97.google.com with SMTP id 6a1803df08f44-69b514d3cf4so75967166d6.0 for ; Wed, 01 May 2024 09:17:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1714580251; x=1715185051; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=fyUAKes1V0sUW115fIJqfu/xF5FBEoeRWIDtsRAc5gI=; b=ZbY+ylTO1dpqK5dHWIC7BXKOghIbrk7JeGTuTXhUB3ZfGPtr3DC/o+dBptPtpuIfcv siKxXZJFHLeDVvFxQgbZ5SdhMC6F8FSRc6KR4FjFjC84Oz3JNUncdCHGCo/sCCznZAb1 AODfIRtmUYswophGig4xLn5tvqJ9FMkyd9UMw= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1714580251; x=1715185051; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=fyUAKes1V0sUW115fIJqfu/xF5FBEoeRWIDtsRAc5gI=; b=NaYThfTneGhwrgzZf/JFGkwCI3hwW3KK3PvxZ+0C7ie8T6VCZifne49mTOXj5oOzYn 8XW95X4sPtw3oFkVaPSyXB/aZ9AsJx1mfAsE4i9JwMcnoszhyIxM9+9HBn/yfnVUQw1z D9EoYowjjyHSWgrOrTB1QjOaR6WDml62fXEBUvNubK7jRnXx7DqYLx7xCaEkh9jUTjgE Ms0DHuc7TaOKrDII2+sxxnlg65VhqNejblxRXHUKSzZSC+A9JwcPcyqMpBv/4DMhhXBf rJmZ5394fRQbleTlC6jJfDRbexxeXHBL5t9OmEc+TbYiWHimSa1PXcYP5LAxh9tKrtRE 4lBQ== X-Gm-Message-State: AOJu0YxMjx9wDbxPVgPLKe2j3GrAVgVmlvV8HKMCsFSM+Fu7T9TJC5nn 7y4wSyVOu+8yc+7I7HE+kYUoMGEDkdInaak/NveHy8G5hbY1jvDOivl/ehDdte1xdKr9oPEfes/ 0O2tSICxZu/iJr3GsDXVPTSXj8xcjR/W7 X-Google-Smtp-Source: AGHT+IGZbOtz8MI9dN00EPplcExVa4hmN6eu8W//whKKe6gkjm+u4PowNpanKrEfctGY8we1W1L3Sv9+XGjN X-Received: by 2002:a05:6214:21ab:b0:6a0:cb4d:7948 with SMTP id t11-20020a05621421ab00b006a0cb4d7948mr2738077qvc.40.1714580251245; Wed, 01 May 2024 09:17:31 -0700 (PDT) Received: from postal.iol.unh.edu (postal.iol.unh.edu. [132.177.123.84]) by smtp-relay.gmail.com with ESMTPS id b6-20020a0cfe66000000b006a0acd9db7fsm1139541qvv.69.2024.05.01.09.17.31 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Wed, 01 May 2024 09:17:31 -0700 (PDT) X-Relaying-Domain: iol.unh.edu Received: from iol.unh.edu (unknown [IPv6:2606:4100:3880:1271:90f9:1b64:f6e6:867f]) by postal.iol.unh.edu (Postfix) with ESMTP id CB66D6052514; Wed, 1 May 2024 12:17:30 -0400 (EDT) From: jspewock@iol.unh.edu To: Luca.Vizzarro@arm.com, wathsala.vithanage@arm.com, yoan.picchi@foss.arm.com, juraj.linkes@pantheon.tech, paul.szczepanek@arm.com, probb@iol.unh.edu, thomas@monjalon.net, Honnappa.Nagarahalli@arm.com Cc: dev@dpdk.org, Jeremy Spewock Subject: [PATCH v2 3/3] dts: Improve logging for interactive shells Date: Wed, 1 May 2024 12:16:23 -0400 Message-ID: <20240501161623.26672-4-jspewock@iol.unh.edu> X-Mailer: git-send-email 2.44.0 In-Reply-To: <20240501161623.26672-1-jspewock@iol.unh.edu> References: <20240312172558.11844-1-jspewock@iol.unh.edu> <20240501161623.26672-1-jspewock@iol.unh.edu> MIME-Version: 1.0 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 From: Jeremy Spewock The messages being logged by interactive shells currently are using the same logger as the node they were created from. Because of this, when sending interactive commands, the logs make no distinction between when you are sending a command directly to the host and when you are using an interactive shell on the host. This change adds names to interactive shells so that they are able to use their own loggers with distinct names. Signed-off-by: Jeremy Spewock --- dts/framework/remote_session/interactive_shell.py | 9 +++++---- dts/framework/testbed_model/node.py | 7 +++++++ dts/framework/testbed_model/os_session.py | 6 ++++-- dts/framework/testbed_model/sut_node.py | 7 ++++++- dts/framework/testbed_model/traffic_generator/scapy.py | 2 +- 5 files changed, 23 insertions(+), 8 deletions(-) diff --git a/dts/framework/remote_session/interactive_shell.py b/dts/framework/remote_session/interactive_shell.py index 0b0ccdb545..eb9c9b6843 100644 --- a/dts/framework/remote_session/interactive_shell.py +++ b/dts/framework/remote_session/interactive_shell.py @@ -24,7 +24,7 @@ InteractiveSSHSessionDeadError, InteractiveSSHTimeoutError, ) -from framework.logger import DTSLogger +from framework.logger import DTSLogger, get_dts_logger from framework.settings import SETTINGS from .interactive_remote_session import InteractiveRemoteSession @@ -66,8 +66,8 @@ class InteractiveShell(ABC): def __init__( self, + name: str, interactive_session: InteractiveRemoteSession, - logger: DTSLogger, get_privileged_command: Callable[[str], str] | None, app_args: str = "", timeout: float = SETTINGS.timeout, @@ -75,8 +75,9 @@ def __init__( """Create an SSH channel during initialization. Args: + name: Name for the interactive shell to use for logging. This name will be appended to + the name of the underlying node which it is running on. interactive_session: The SSH session dedicated to interactive shells. - logger: The logger instance this session will use. get_privileged_command: A method for modifying a command to allow it to use elevated privileges. If :data:`None`, the application will not be started with elevated privileges. @@ -91,7 +92,7 @@ def __init__( self._stdout = self._ssh_channel.makefile("r") self._ssh_channel.settimeout(timeout) self._ssh_channel.set_combine_stderr(True) # combines stdout and stderr streams - self._logger = logger + self._logger = get_dts_logger(f"{interactive_session._node_config.name}.{name}") self._timeout = timeout self._app_args = app_args self._start_application(get_privileged_command) diff --git a/dts/framework/testbed_model/node.py b/dts/framework/testbed_model/node.py index 74061f6262..a5beeae7e7 100644 --- a/dts/framework/testbed_model/node.py +++ b/dts/framework/testbed_model/node.py @@ -199,6 +199,7 @@ def create_interactive_shell( shell_cls: Type[InteractiveShellType], timeout: float = SETTINGS.timeout, privileged: bool = False, + name: str = "", app_args: str = "", ) -> InteractiveShellType: """Factory for interactive session handlers. @@ -210,6 +211,8 @@ def create_interactive_shell( timeout: Timeout for reading output from the SSH channel. If you are reading from the buffer and don't receive any data within the timeout it will throw an error. privileged: Whether to run the shell with administrative privileges. + name: The name to use for the interactive application in the logs. If not specified, + this will default to the name of `shell_cls`. app_args: The arguments to be passed to the application. Returns: @@ -218,10 +221,14 @@ def create_interactive_shell( if not shell_cls.dpdk_app: shell_cls.path = self.main_session.join_remote_path(shell_cls.path) + if name == "": + name = shell_cls.__name__ + return self.main_session.create_interactive_shell( shell_cls, timeout, privileged, + name, app_args, ) diff --git a/dts/framework/testbed_model/os_session.py b/dts/framework/testbed_model/os_session.py index d5bf7e0401..1f6d8257ed 100644 --- a/dts/framework/testbed_model/os_session.py +++ b/dts/framework/testbed_model/os_session.py @@ -134,6 +134,7 @@ def create_interactive_shell( shell_cls: Type[InteractiveShellType], timeout: float, privileged: bool, + name: str, app_args: str, ) -> InteractiveShellType: """Factory for interactive session handlers. @@ -146,14 +147,15 @@ def create_interactive_shell( reading from the buffer and don't receive any data within the timeout it will throw an error. privileged: Whether to run the shell with administrative privileges. + name: Name for the shell to use in the logs. app_args: The arguments to be passed to the application. Returns: An instance of the desired interactive application shell. """ return shell_cls( - self.interactive_session.session, - self._logger, + name, + self.interactive_session, self._get_privileged_command if privileged else None, app_args, timeout, diff --git a/dts/framework/testbed_model/sut_node.py b/dts/framework/testbed_model/sut_node.py index 97aa26d419..0bddef6f44 100644 --- a/dts/framework/testbed_model/sut_node.py +++ b/dts/framework/testbed_model/sut_node.py @@ -442,6 +442,7 @@ def create_interactive_shell( shell_cls: Type[InteractiveShellType], timeout: float = SETTINGS.timeout, privileged: bool = False, + name: str = "", app_parameters: str = "", eal_parameters: EalParameters | None = None, ) -> InteractiveShellType: @@ -459,6 +460,8 @@ def create_interactive_shell( reading from the buffer and don't receive any data within the timeout it will throw an error. privileged: Whether to run the shell with administrative privileges. + name: The name to use for the interactive application in the logs. If not specified, + this will default to the name `shell_cls`. eal_parameters: List of EAL parameters to use to launch the app. If this isn't provided or an empty string is passed, it will default to calling :meth:`create_eal_parameters`. @@ -478,7 +481,9 @@ def create_interactive_shell( self.remote_dpdk_build_dir, shell_cls.path ) - return super().create_interactive_shell(shell_cls, timeout, privileged, app_parameters) + return super().create_interactive_shell( + shell_cls, timeout, privileged, name, app_parameters + ) def bind_ports_to_driver(self, for_dpdk: bool = True) -> None: """Bind all ports on the SUT to a driver. diff --git a/dts/framework/testbed_model/traffic_generator/scapy.py b/dts/framework/testbed_model/traffic_generator/scapy.py index d0e0a7c64e..5676235119 100644 --- a/dts/framework/testbed_model/traffic_generator/scapy.py +++ b/dts/framework/testbed_model/traffic_generator/scapy.py @@ -262,7 +262,7 @@ def __init__(self, tg_node: Node, config: ScapyTrafficGeneratorConfig): ), "Linux is the only supported OS for scapy traffic generation" self.session = self._tg_node.create_interactive_shell( - PythonShell, timeout=5, privileged=True + PythonShell, timeout=5, privileged=True, name="ScapyXMLRPCServer" ) # import libs in remote python console -- 2.44.0