From f97adb4c5ddda812c6bd58949ee2cdd74ea0fb7f Mon Sep 17 00:00:00 2001 From: uber-dendy Date: Mon, 30 Sep 2024 18:26:21 +0300 Subject: [PATCH] Add additional logging for SSH runtime output timeouts and escalation messages (#84008) Signed-off-by: Yuri Savinkin Co-authored-by: Abhijeet Kasurde --- .../fragments/84008-additional-logging.yml | 3 +++ lib/ansible/plugins/connection/ssh.py | 16 +++++++++------- 2 files changed, 12 insertions(+), 7 deletions(-) create mode 100644 changelogs/fragments/84008-additional-logging.yml diff --git a/changelogs/fragments/84008-additional-logging.yml b/changelogs/fragments/84008-additional-logging.yml new file mode 100644 index 00000000000..80bd3a7ddd9 --- /dev/null +++ b/changelogs/fragments/84008-additional-logging.yml @@ -0,0 +1,3 @@ +minor_changes: + - Added a -vvvvv log message indicating when a host fails to produce output within the timeout period. + - SSH Escalation-related -vvv log messages now include the associated host information. diff --git a/lib/ansible/plugins/connection/ssh.py b/lib/ansible/plugins/connection/ssh.py index 83ff03631e6..b5cda5a8518 100644 --- a/lib/ansible/plugins/connection/ssh.py +++ b/lib/ansible/plugins/connection/ssh.py @@ -1049,6 +1049,8 @@ class Connection(ConnectionBase): self._terminate_process(p) raise AnsibleError('Timeout (%ds) waiting for privilege escalation prompt: %s' % (timeout, to_native(b_stdout))) + display.vvvvv(f'SSH: Timeout ({timeout}s) waiting for the output', host=self.host) + # Read whatever output is available on stdout and stderr, and stop # listening to the pipe if it's been closed. @@ -1117,23 +1119,23 @@ class Connection(ConnectionBase): if states[state] == 'awaiting_escalation': if self._flags['become_success']: - display.vvv(u'Escalation succeeded') + display.vvv(u'Escalation succeeded', host=self.host) self._flags['become_success'] = False state += 1 elif self._flags['become_error']: - display.vvv(u'Escalation failed') + display.vvv(u'Escalation failed', host=self.host) self._terminate_process(p) self._flags['become_error'] = False raise AnsibleError('Incorrect %s password' % self.become.name) elif self._flags['become_nopasswd_error']: - display.vvv(u'Escalation requires password') + display.vvv(u'Escalation requires password', host=self.host) self._terminate_process(p) self._flags['become_nopasswd_error'] = False raise AnsibleError('Missing %s password' % self.become.name) elif self._flags['become_prompt']: # This shouldn't happen, because we should see the "Sorry, # try again" message first. - display.vvv(u'Escalation prompt repeated') + display.vvv(u'Escalation prompt repeated', host=self.host) self._terminate_process(p) self._flags['become_prompt'] = False raise AnsibleError('Incorrect %s password' % self.become.name) @@ -1372,18 +1374,18 @@ class Connection(ConnectionBase): # only run the reset if the ControlPath already exists or if it isn't configured and ControlPersist is set # 'check' will determine this. cmd = self._build_command(self.get_option('ssh_executable'), 'ssh', '-O', 'check', self.host) - display.vvv(u'sending connection check: %s' % to_text(cmd)) + display.vvv(u'sending connection check: %s' % to_text(cmd), host=self.host) p = subprocess.Popen(cmd, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE) stdout, stderr = p.communicate() status_code = p.wait() if status_code != 0: - display.vvv(u"No connection to reset: %s" % to_text(stderr)) + display.vvv(u"No connection to reset: %s" % to_text(stderr), host=self.host) else: run_reset = True if run_reset: cmd = self._build_command(self.get_option('ssh_executable'), 'ssh', '-O', 'stop', self.host) - display.vvv(u'sending connection stop: %s' % to_text(cmd)) + display.vvv(u'sending connection stop: %s' % to_text(cmd), host=self.host) p = subprocess.Popen(cmd, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE) stdout, stderr = p.communicate() status_code = p.wait()