Improve ssh connection debug messages #22097
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
radeksimko
reviewed
Jul 19, 2019
communicator/ssh/communicator.go
Outdated
| if err != nil { | ||
| err = errors.New(fmt.Sprintf("ssh %s@%s: %s", c.connInfo.User, hostAndPort, err)) |
There was a problem hiding this comment.
Thank you for improving all the debug messages - these look 👍 to me.
How do you feel about using https://github.com/hashicorp/errwrap for wrapping the error here, so we're not just turning the error into a string, but retaining all useful details?
e.g.
errwrap.Wrapf(fmt.Sprintf("Failed to establish SSH connection (%s@%s): {{err}}", c.connInfo.User, hostAndPort), err)There was a problem hiding this comment.
I was wondering if there was a better way. I'll make that change.
radeksimko
added
the
waiting-response
1) Mention the host and port in the "Connecting..." message. 2) Mention the username in the post-connection handshaking message. 3) If handshaking fails, mention the user, host, and port in the error message that will eventually be returned to the user.
radeksimko
removed
the
waiting-response
|
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
ghost
locked and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mention the host and port in the "Connecting..." message.
Mention the username in the post-connection handshaking message.
If handshaking fails, mention the user, host, and port in the error
message that will eventually be returned to the user.