Skip to content

Commit

Permalink
docs: note where healthcheck endpoint is located
Browse files Browse the repository at this point in the history
This information is available in the under-pressure documentation but it is a little bit buried
  • Loading branch information
MzUgM authored Sep 14, 2023
1 parent d8bac65 commit 6a9c545
Showing 1 changed file with 1 addition and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ A **required** object with the following settings:

- **`hostname`** (**required**, `string`) — Hostname where Platformatic Service server will listen for connections.
- **`port`** (**required**, `number`) — Port where Platformatic Service server will listen for connections.
- **`healthCheck`** (`boolean` or `object`) — Enables the health check endpoint.
- **`healthCheck`** (`boolean` or `object`) — Enables the health check endpoint, located at `/status`.
- Powered by [`@fastify/under-pressure`](https://github.com/fastify/under-pressure).
- The value can be an object, used to specify the interval between checks in milliseconds (default: `5000`)

Expand Down

0 comments on commit 6a9c545

Please sign in to comment.