WIP: Add health endpoint #159
Conversation
|
I added the external library https://github.com/itchio/ox . That library contains wrappers for many Windows syscall. I used some of them to get information about the repository path write permission for current user. I had to call a Windows API directly, however I already made a pull request to the original library to add that wrapper. I've tested the code on Windows and Linux. Do I need to write some tests for this? If so, do you have any suggestion? Testing permissions and free space might be difficult... |
Enrico204
force-pushed
the
add-health-endpoint
branch
from
a59f3eb
to
3c1b00f
Compare
|
I would like to give this PR a bump. Edit: As 80% of the work in this PR is done, I am willing to pick it up if the maintainers are signalling to get the functionality merged in the near future. I am in a quite fortunate situation that I could actually do this during my work time as we have a dedicated time budget for learning and OSS contributions. |
| err := unix.Statfs(path, &stat) | ||
| if err != nil { | ||
| return 0, err | ||
| } |
There was a problem hiding this comment.
This check will probably report incorrect usage numbers for btrfs-based filesystems.
What is the purpose of this change? What does it change?
This pull request adds an endpoint named
/health. It replies with:200 OKwhen the repository base path is writable and there is some free space left500 Internal Server Errorwhen either the path is not writable byrest-server, or the disk is fullThis endpoint can be used to monitor the status of a
rest-serverdaemon (for example in k8s / docker)Was the change discussed in an issue or in the forum before?
Feature was requested and is being discussed here: #147
Checklist
changelog/unreleased/that describes the changes for our users (template here)gofmton the code in all commits