docs: explain Terminus behavior in usage docs #274
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
| You can use it to start failing readiness probe. | ||
| 2. Execute and wait for `beforeShutdown`. | ||
| Here you can log the fact that shutdown has started. | ||
| You can also delay here shutting down HTTP server, so that the service is taken out from load balancer first. |
There was a problem hiding this comment.
Suggested change
| You can also delay here shutting down HTTP server, so that the service is taken out from load balancer first. | |
| If you perform asynchronous code, this will delay the shutting down of the HTTP server, but if you've configured your readiness probe correctly, your instance may be removed from your load balancer before this completes. |
|
|
||
| With `healthChecks` you can register multiple health checks, so you can have a separate liveness and readiness probe implementations. | ||
|
|
||
| Note, that when `sendFailuredDuringShutdown` is set to `true` (default) and Terminus enters shutting down state, it will return failure without calling provided health check implementation. |
There was a problem hiding this comment.
Suggested change
| Note, that when `sendFailuredDuringShutdown` is set to `true` (default) and Terminus enters shutting down state, it will return failure without calling provided health check implementation. | |
| Note, that when `sendFailuresDuringShutdown` is set to `true` (default) and Terminus enters the shutting down state, it will send failures without calling your provided health check implementation. |
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.
Summary
As I wanted to use Terminus in my project, I struggled to understand how it will behave. In the end, I went through tests and sources to understand its behavior. I have documented it, so it is easier to understand to others new to the project.
Changelog
Test Plan