Feature request: health check endpoint in grommunio-sync

[dfied]

Hi,

I'd like to monitor grommunio-sync with an external monitoring system. Microsoft Exchange offers an unauthenticated endpoint on /Microsoft-Server-ActiveSync/healthcheck.htm (reference https://www.frankysweb.de/en/exchange-2016-healthcheck-urls-for-loadbalancer/). This endpoint can be used by monitoring systems as well as by load balancing systems to see if sync is reachable.

Would it be possible to integrate an unauthenticated health check endpoint in sync?
I'd suggest to implement a more intelligent endpoint that does some deeper checking than MS Exchange - e.g. tries to load php_mapi and also checks if gromox backend services are available.

Thank you!
Daniel

[grammmichi]

I thought about this a little bit, but to test the stack you have to login. Sync could check if php-mapi is available by itself. Any deeper checks we would need to login, to know if gromox/zcore/ldap/db is available.
In order to do that on an unauthenticated request, we would need to save the login data (plain!) in some config data. Doesn't sound like the best idea.
In general I think php-mapi couldn't really only break in production if you update your system or configs.

But you could check the main endpoint already.
Do an unauthenticated GET request to:
https://yourserver/Microsoft-Server-ActiveSync there are two outcomes:

• you get a 401: everything is fine so far (php-mapi included correctly)
• anything else, there is an issue

Then you could do that authenticated:

• you get a 200: everything is OK, gromox stack OK so far
• anything else, there is an issue

I could think about adding some get-parameter/header that if set we fail hard and early (before auth) if redis is not available. Right now I think redis connection soft fails without limiting general access.

[dfied]

@grammmichi Thanks for your thoughts and answer.

If it's possible to implement a health command like GET /Microsoft-Server-ActiveSync/?cmd=healthcheck without auth or get a 200 reply without auth on GET /Microsoft-Server-ActiveSync/healthcheck.htm (MS Default) that would help in my case.
It it's not worth working on that, you may close this issue.