Skip to content

feat!: Implement health check API using HealthCheck trait - #255

Merged
spencewenski merged 1 commit into
mainfrom
gh-241-health-check-in-api
Jul 1, 2024
Merged

feat!: Implement health check API using HealthCheck trait#255
spencewenski merged 1 commit into
mainfrom
gh-241-health-check-in-api

Conversation

@spencewenski

Copy link
Copy Markdown
Member
  • Use the HealthCheck trait to implement the _health API endpoint and the health CLI command in addition to pre-boot checks.
  • Create a HealthCheckRegistry and the `App#health_checks method to allow consumers to provide their own health checks that will be run along with the defualt ones.
  • Remove the health checks from the ServiceRegistry.

Closes #241

- Use the `HealthCheck` trait to implement the `_health` API endpoint
and the health CLI command in addition to pre-boot checks.
- Create a `HealthCheckRegistry` and the `App#health_checks method to
allow consumers to provide their own health checks that will be run
along with the defualt ones.
- Remove the health checks from the `ServiceRegistry`.

Closes #241
@spencewenski
spencewenski force-pushed the gh-241-health-check-in-api branch from 8f3fcaf to 4fb79e9 Compare July 1, 2024 10:20
@codecov

codecov Bot commented Jul 1, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 37.50000% with 125 lines in your changes missing coverage. Please review.

Project coverage is 44.00%. Comparing base (b05d377) to head (4fb79e9).

Files Coverage Δ
src/health_check/default.rs 100.00% <100.00%> (ø)
src/service/registry.rs 98.14% <ø> (+26.14%) ⬆️
src/api/cli/roadster/health.rs 0.00% <0.00%> (ø)
src/health_check/database.rs 63.15% <0.00%> (+1.61%) ⬆️
src/health_check/registry.rs 87.50% <87.50%> (ø)
src/app/context.rs 26.08% <0.00%> (-1.70%) ⬇️
src/health_check/sidekiq_enqueue.rs 63.15% <63.15%> (ø)
src/app/mod.rs 0.00% <0.00%> (ø)
src/health_check/mod.rs 10.00% <0.00%> (+10.00%) ⬆️
src/health_check/sidekiq_fetch.rs 50.00% <50.00%> (ø)
... and 3 more

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b05d377...4fb79e9. Read the comment docs.

@spencewenski
spencewenski merged commit 8225647 into main Jul 1, 2024
@spencewenski
spencewenski deleted the gh-241-health-check-in-api branch July 1, 2024 10:31
@github-actions github-actions Bot mentioned this pull request Jul 1, 2024
spencewenski pushed a commit that referenced this pull request Jul 1, 2024
## 🤖 New release
* `roadster`: 0.3.5 -> 0.4.0

<details><summary><i><b>Changelog</b></i></summary><p>

<blockquote>

##
[0.4.0](roadster-v0.3.5...roadster-v0.4.0)
- 2024-07-01

### Added
- [**breaking**] Implement health check API using `HealthCheck` trait
([#255](#255))
- [**breaking**] Switch to Axum's `FromRef` for custom state
([#250](#250))

### Other
- [**breaking**] Remove deprecated items in preparation of 0.4 release
([#253](#253))
- Add example for integrating with Leptos
([#252](#252))
- Use small number of sidekiq workers for `full` example in dev/test
([#251](#251))
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/MarcoIeni/release-plz/).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use HealthCheck trait to implement the "health check" api

1 participant