Provide api health overview

hbz / lobid

Linking Open Bibliographic Data

https://lobid.org/

Eclipse Public License 2.0

15 stars 4 forks source link

Provide api health overview #523

Closed dr0i closed 3 months ago

dr0i commented 5 months ago

Add an api health overview. Provide a bit of status history.

dr0i commented 5 months ago

Discussed with @Phu2 : using monit to a) push-wise be informed when something changes and b) reuse monit's html view. Revisioned in internal git daemon at gaia.

dr0i commented 5 months ago

[x] q3 as server: must be able to receive mails
[x] configure /etc/mail/aliases to write monit mails into an file on its own
[x] configure monit rc's(/etc/monit/conf.d/*.rc) to also write to q3 (by just repeating "alert $mailadress")
[x] write script that watches changes on the inbox
[x] add checking log files (ETL of Alma to lobid-resources) to know when the last ETL was successful
[x] if changes on the inbox appear, get the server's monit html views and ETL them into one view and copy them to https://lobid.org/apihealth/index.html

acka47 commented 5 months ago

There exists some FOSS software for this. Have you checked or isn't that useful for us. Examples:

Cachet: https://github.com/cachethq
gatus: https://github.com/TwiN/gatus
Vigil: https://github.com/valeriansaliou/vigil

dr0i commented 4 months ago

Simple api health site is ready: https://lobid.org/apihealth/

Re other software: dont' fit in our environment (re monit), complex. One thing that would bring more flexibility in building the HTML: There is a monit API that provides XML , called like curl -u name:passwd localhost:2812/_status?format=xml . Using this XML would make it easier to build a more elegant view. (Documented in the internal Wiki https://dienst-wiki.hbz-nrw.de/display/SEM/Api+health+Seite)

dr0i commented 3 months ago