Health endpoint not documented and returns empty result - could return something like "READY" or "INITIALIZING"

[Nachtfalkeaw]

Hello,

the configuration explains that there exists an endpoint. However I did not find the exact page and tried with /health /state /status until I foud /ready
However the result is empty - I would expect something like

• ready
• starting
• stopping
  or whatever

config:

health:
  address: 127.0.0.1
  port: 8888

Result:

[root@u999fmlab001l flp]# curl 127.0.0.1:8888/ready
{}
[root@u999fmlab001l flp]#

[jotak]

Yeah that's undocumented and honestly I'm not sure you'll get a lot from these endpoints, they have been implemented but mostly unused.
We use actually heptiolabs/healthcheck library: https://github.com/vmware-archive/healthcheck?tab=readme-ov-file#http-endpoints

So you can query /ready like you did, or /live.
By default, only the HTTP status code is returned by the probe, so use curl -i for instance. Or use /ready?full=1 to get the json content

[Nachtfalkeaw]

I was more confused that I have to Set to Open Ports, one for metrics and the other for health Check. Not Sure If Prometheus öfters a health Check Endpoint, too and the other config can be removed.

[jotak]

Yes indeed, prometheus can also be a way to check health (e.g. with the "up" metric)
I've opened a PR to make the health server optional, and disabled by default: #966

[jotak]

I'm closing this issue; the health server is now optional. Let me know if something else is needed.