Custom health checks API and "pebble checks" CLI command #3
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
Conflicts: - cmd/pebble/cmd_help.go - internal/daemon/api.go
Conflicts resolved: - internal/overlord/checkstate/manager.go - internal/overlord/checkstate/manager_test.go - internal/overlord/servstate/handlers.go
…ling (canonical#85) This implements custom health checks and the `on-check-failure` logic per the [spec] (https://docs.google.com/document/d/1d6-h3UAt2VPUSvlkVF30l8iuDW8raRNkHbp5M6NUo1A/edit). Basically, you specify the list of custom health checks in a new top-level configuration object named `checks` (see the `README.md` documentation). They can be HTTP, TCP, or exec checks. Then in your service configuration you specify any action you want to perform `on-check-failure` for the various checks. Here's an example configuration with a single HTTP-based check, and a single service that will be restarted if the check fails (twice in a row): services: web-server: command: python3 webapp.py --port=8080 on-check-failure: server-up: restart checks: server-up: period: 5s failures: 2 http: url: http://localhost:8080/is-up It's a good amount of code, though at least half of it is tests. The CLI and APIs are coming in canonical#86. I'm pretty happy with how it turned out, particularly the checkers and check manager. However, the wiring up of the check manager and the service manager is a little odd, because they are mutually dependent on one another: we have to tell the check manager about plan updates (from the service manager), and we have to tell the service manager about check failures (from the check manager). Open to suggestions on that or anything else.
|
Closing now that canonical#85 is merged. See canonical#86 |
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.
Temporary PR to allow review of just the API and CLI parts of custom health checks. The real PR is canonical#86