Improve error message when supervisor unavailable #5465
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
This fixes #5367. Previously, when doing a `hab svc (load|unload)`, or any command that requires remote control of the supervisor, if there was a network issue, we would simply return the upstream description of the problem (most often, something like `Connection refused (os error 111)`. This wasn't a very user friendly error message. Now, on any `SvcClient` command that returns an `SvcClientError::Io` error, we will print the following: ``` ✗✗✗ ✗✗✗ Unable to contact the Supervisor. ✗✗✗ ✗✗✗ If the Supervisor you are contacting is local, this probably means it is not running. You can run a Supervisor in the foreground with: ✗✗✗ ✗✗✗ hab sup run ✗✗✗ ✗✗✗ Or try restarting the Supervisor through your oerating systems init process. ✗✗✗ ✗✗✗ Original error is: ✗✗✗ ✗✗✗ Connection refused (os error 111) ✗✗✗ ``` Which is, I think, much more helpful. Signed-off-by: Adam Jacob <adam@chef.io>
adamhjk
requested review from
christophermaier,
fnichol and
reset
as code owners
|
Thanks for the pull request! Here is what will happen next:
Thank you for contributing! |
mwrock
previously requested changes
Aug 16, 2018
components/sup-client/src/lib.rs
Outdated
| "Unable to contact the Supervisor.\n\n\ | ||
| If the Supervisor you are contacting is local, this probably means it is not running. You can run a Supervisor in the foreground with:\n\n\ | ||
| hab sup run\n\n\ | ||
| Or try restarting the Supervisor through your oerating systems init process.\n\n\ |
There was a problem hiding this comment.
oerating -> operating
init process -> init process or Windows service
Windows users will not likely be familiar with the term init process
There was a problem hiding this comment.
systems -> system's, too
christophermaier
previously approved these changes
Aug 17, 2018
|
This is a nice improvement! I think we could go even one better by checking whether there is a supervisor running locally and/or whether a |
Signed-off-by: Jon Bauman <5906042+baumanj@users.noreply.github.com>
chef-ci
pushed a commit
that referenced
this pull request
Sep 6, 2018
Obvious fix; these changes are the result of automation not creative thinking.
|
Hey guys! It's been a while since I've suggested that improvement and I would say that it is really great to see that changes are accepted. Such a good community, thank you all! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This fixes #5367.
Previously, when doing a
hab svc (load|unload), or any command thatrequires remote control of the supervisor, if there was a network issue,
we would simply return the upstream description of the problem (most
often, something like
Connection refused (os error 111).This wasn't a very user friendly error message. Now, on any
SvcClientcommand that returns an
SvcClientError::Ioerror, we will print thefollowing:
Which is, I think, much more helpful.
Signed-off-by: Adam Jacob adam@chef.io