changelog-app[bot]
commented
7 months ago Generate changelog in changelog-dir>`changelog/@unreleased`</changelog-dir
What do the change types mean?
- `feature`: A new feature of the service. - `improvement`: An incremental improvement in the functionality or operation of the service. - `fix`: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way. - `break`: Has the potential to break consumers of this service's API, inclusive of both Palantir services and external consumers of the service's API (e.g. customer-written software or integrations). - `deprecation`: Advertises the intention to remove service functionality without any change to the operation of the service itself. - `manualTask`: Requires the possibility of manual intervention (running a script, eyeballing configuration, performing database surgery, ...) at the time of upgrade for it to succeed. - `migration`: A fully automatic upgrade migration task with no engineer input required. _Note: only one type should be chosen._How are new versions calculated?
- ❗The `break` and `manual task` changelog types will result in a major release! - 🐛 The `fix` changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease. - ✨ All others will result in a minor version release.Type
Description
Before this PR
All health checks were write-only - once registered they could never be accessed again or overwritten.
After this PR
==COMMIT_MSG== Added HealthCheckRegistry::register_if_absent and downcast support to HealthCheck. ==COMMIT_MSG==
This supports similar workflows to https://github.com/palantir/witchcraft-rust-logging/pull/12, where you want to have multiple pieces of code contribute state to a health check. They can do that by all calling register_if_absent and then downcasting the returned check.
Since we pull the health check name from the check trait itself, we unfortunately can't defer creation of the check until we know it doesn't already exist like the gauge APIs do. Some check names are dynamically generated so I don't think there's a great way around that, but it shouldn't matter too much in practice.