Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

hot_reload: Add a description for hot-reloaded count endpoint #1192

Merged
merged 1 commit into from
Dec 8, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions administration/hot-reload.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,22 @@ Hot reloading also can be kicked via `SIGHUP`.

`SIGHUP` signal is not supported on Windows. So, users can't enable this feature on Windows.

## How to confirm reloaded or not

### via HTTP

The number of hot reloaded count can be obtained via the HTTP endpoint that is:

* `GET /api/v2/reload`

The endpoint returns the count of hot-reloaded as follows:

```json
{"hot_reload_count":3}
patrick-stephens marked this conversation as resolved.
Show resolved Hide resolved
```

The default value of that number is 0.

## Limitations

The hot reloading feature is currently working on Linux and macOS. Windows is not supported yet.
Expand Down