feat: add Pebble check-failed and check-recovered events #17655
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
8 similar comments
This was referenced Jul 4, 2024
tonyandrewmeyer
force-pushed
the
add-pebble-check-events
branch
from
57649f5 to
65ba6c5
Compare
benhoyt
added a commit
to canonical/pebble
that referenced
this pull request
Jul 5, 2024
…-check (#444) For notices of kind `change-updated`, the notice data will include the `kind` field that is standard for these notices, but also when `kind` is `perform-check` or `recover-check`, it will also include `check-name`, set to the name of the check that is being performed or recovered. This is the Pebble portion of [OP046](https://docs.google.com/document/d/13ItH8l5ZSmmv9WqZXpqjV8EifZU5e3zxINiNLubnC68/edit). It is used by Juju ([PR](juju/juju#17655)) and ops ([PR](canonical/operator#1281)). --------- Co-authored-by: Ben Hoyt <[email protected]>
benhoyt
reviewed
Jul 5, 2024
tonyandrewmeyer
force-pushed
the
add-pebble-check-events
branch
from
fa5dea5 to
5960c2b
Compare
|
/build |
2 similar comments
|
/build |
|
/build |
…ebble-check-recovered events These events are triggered by Pebble notices of type 'change-updated', when the change kind is 'perform-check' and 'recover-check' and the status of the change is at the end of the lifecycle (error or done). No other change-updated notices trigger events.
tonyandrewmeyer
force-pushed
the
add-pebble-check-events
branch
from
8cac7bc to
d4db796
Compare
|
/build |
hpidcock
approved these changes
Jul 16, 2024
|
/merge |
hpidcock
force-pushed
the
add-pebble-check-events
branch
from
6259b88 to
2096166
Compare
|
/build |
|
/merge |
tonyandrewmeyer
added a commit
to canonical/operator
that referenced
this pull request
Jul 17, 2024
…1281) Two new event types are supported (actually getting these events requires Juju 3.6b2 or higher): * `PebbleChangeFailedEvent` - emitted when a Pebble check in a container hits the failure threshold * `PebbleChangeRecoveredEvent` - emitted when a Pebble check in a container passes after previously hitting the failure threshold Each event type has a single new attribute (in addition to those inherited from `WorkloadEvent`): * `info` - this is a shortcut to Pebble's `get_check` method (not otherwise accessible from the charm), but will only query Pebble if more than the `name` is requested, and will cache the result on the event instance. Two new enums are added to Pebble, to make it easier to work with these events, particularly with Harness: * `ChangeStatus` - the possible values for `ops.pebble.Change.status` (note that this is the full list, but we only expect charms to see Doing, Done, and Error for now). * `ChangeKind` - the possible values for `ops.pebble.Change.kind` (again, this is the current full list, but we only expect charms to see perform-check and recover-check at the moment). `Harness.pebble_notify` is extended to support emitting the two new events. This requires implementation knowledge (that the check events are triggered by a Pebble notice of type change-updated), but provides minimal support for testing with Harness, and will be supplemented by user-friendly testing in Scenario. The testing Pebble backend gains an implementation for `get_change` and `get_checks`. These are not used directly here, but will be used in Scenario, and it makes more sense to have the implementation in ops. This is the ops portion of [OP046](https://docs.google.com/document/d/13ItH8l5ZSmmv9WqZXpqjV8EifZU5e3zxINiNLubnC68/edit). It requires a [corresponding change to Pebble](canonical/pebble#444) and [change to Juju](juju/juju#17655).
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 creates new
<container-name>-pebble-check-failedand<container-name>-pebble-check-failedhooks, which are triggered by Pebble change-update notices of particular kinds & statuses, with the effect that we'll now respond to Pebble checks reaching the failure threshold, or passing after having reached the threshold, by sending a pebble-check-failed or pebble-check-recovered event to the charm.QA steps
Test the hooks directly:
Test the shell test:
./main.sh -p k8s -c minikube sidecar test_pebble_checksDocumentation changes
Links
Jira card: CHARMTECH-109