-
Notifications
You must be signed in to change notification settings - Fork 40
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README with Expected Behavior when ESM is Critical #54
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good. No required changes but I have a couple small tweaks to suggest (in line)...
@@ -100,6 +100,14 @@ continually watch Consul for updates to the catalog and perform health checks de | |||
external nodes it discovers. This allows externally registered services and checks to access | |||
the same features as if they were registered locally on Consul agents. | |||
|
|||
Each ESM registers a health check for itself with the agent with | |||
`"DeregisterCriticalServiceAfter": "30m"`, which is currently not configurable. This means after | |||
failing its health check, the ESM will switch from passing status to critical status. If the ESM |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the comma after 'check' is unnecessary.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was intrigued by comma rules and read up on commas after introductory phrases. It looks like it's convention to omit a comma if the introductory phrase is short and the omission doesn't lead to confusion. If the phrase is 4+ words, there is more merit to the comma. I'm leaning towards erring on the side of caution and keeping this comma in case the intro phrase is long enough for the reader to lose the flow and break of the sentence.
@eikenb - thanks for the review and feedback! I leaned away from omitting one of the commas and didn't want to merge in case you felt strongly about it. Let me know your thoughts! |
Added a paragraph for more clarity on what happens when ESM has critical status and how its external health services are handled.
Resolves #39