2021-04-13 03:02:14 +02:00
|
|
|
# Monitoring the platform
|
|
|
|
|
|
2022-12-26 23:52:03 +01:00
|
|
|
The monitoring design of Kanidm is still very much in its infancy -
|
2022-05-25 23:38:28 +02:00
|
|
|
[take part in the dicussion at github.com/kanidm/kanidm/issues/216](https://github.com/kanidm/kanidm/issues/216).
|
2021-04-13 03:02:14 +02:00
|
|
|
|
|
|
|
|
## kanidmd
|
|
|
|
|
|
2022-12-26 23:52:03 +01:00
|
|
|
kanidmd currently responds to HTTP GET requests at the `/status` endpoint with a JSON object of
|
2022-05-25 23:38:28 +02:00
|
|
|
either "true" or "false". `true` indicates that the platform is responding to requests.
|
2021-04-13 03:02:14 +02:00
|
|
|
|
2022-12-26 23:52:03 +01:00
|
|
|
| URL | `<hostname>/status` |
|
|
|
|
|
| ------------------ | ------------------------------------------------ |
|
|
|
|
|
| Example URL | `https://example.com/status` |
|
|
|
|
|
| Expected response | One of either `true` or `false` (without quotes) |
|
|
|
|
|
| Additional Headers | x-kanidm-opid |
|
|
|
|
|
| Content Type | application/json |
|
|
|
|
|
| Cookies | kanidm-session |
|
