Skip to content

Commit

Permalink
fixup! Indicate mutating health functions
Browse files Browse the repository at this point in the history
  • Loading branch information
omus committed Mar 8, 2024
1 parent b3b9eae commit 59ae13f
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion src/graceful_termination.jl
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Julia process.
```julia
app_status = AppStatus()
graceful_terminator(() -> shutdown(app_status))
graceful_terminator(() -> shutdown!(app_status))
```
## Kubernetes Setup
Expand Down
2 changes: 1 addition & 1 deletion src/health.jl
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Construct an application `Deputy` which provides health check endpoints.
## Keywords
- `shutdown_handler` (optional): A zero-argument function which allows the user to provide
a custom callback function for when `shutdown(::Deputy)` is called.
a custom callback function for when `shutdown!(::Deputy)` is called.
- `shutdown_handler_timeout::Period` (optional): Specifies the maximum execution duration of
a `shutdown_handler`.
"""
Expand Down
2 changes: 1 addition & 1 deletion src/server.jl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Starts a non-blocking `HTTP.Server` responding to requests to `deputy` health ch
following health check endpoints are available:
- `/health/live`: Is the server is alive/running?
- `/health/ready`: Is the server ready (has `readied(deputy)` been called)?
- `/health/ready`: Is the server ready (has `readied!(deputy)` been called)?
These endpoints will respond with HTTP status `200 OK` on success or
`503 Service Unavailable` on failure.
Expand Down
2 changes: 1 addition & 1 deletion test/health.jl
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ end
r = HTTP.get("http://$localhost:$port/health/live")
@test r.status == 200

# Faking shutting down. Normal usage would call `shutdown` but we don't want to
# Faking shutting down. Normal usage would call `shutdown!` but we don't want to
# terminate our test process.
deputy.shutting_down = true

Expand Down

0 comments on commit 59ae13f

Please sign in to comment.