Simple Health Monitor

SimpleHealthMonitor Artikelen

SimpleHealthMonitor is een Joomla System Plugin die de technische gezondheid van een Joomla-website bewaakt.

e plugin voert een aantal ingebouwde health checks uit, berekent een Health Score en publiceert een beveiligd JSON-endpoint dat kan worden gebruikt door externe monitoringdiensten zoals uptimerobot.com, Uptime Kuma, Zabbix en andere HTTP-monitoringtools.

De naam SimpleHealthMonitor is bewust.... de tool is bedoeld om klein te blijven. Er zijn al voldoende Joomla tools die de gezondheid van een site bekijken of kunnen monitoren.
Wat deze plugin toevoegd is dat er op 3 kritieke punten wordt gemeten die óf een juiste signalering kunenn blokkeren (mail werkt niet, een schedule is onbedoeld gestopt) of fouten optreden waardoor het lijkt of de site online is maar bepaalde verwachte teksten niet toont.

Alle product documentatie is beschikbaar in het menu (de links openen een GitHub pagina),
Als je inlogt op de site (maak eventueel een account aan....) krijg je in het menu ook een snelkoppeling naar de JSON output van deze website te zien.

Vereisten

Joomla 5 of Joomla 6
PHP 8.1
MariaDB 10.4

Downloadlink

https://raw.githubusercontent.com/adstam/SimpleHealthMonitor/main/simplehealthmonitor.zip

Talen

Op dit moment zijn beschikbaar*:

Engels
Nederlands
Duits
Frans
Spaans

* De vertalingen vanuit het Nederlands zijn gemaakt met Mistral Vibe. Verbetersuggesties worden op prijs gesteld! Deel via het contactfomulier.

Handleiding

Installatie

Installeer de plugin via het Joomla installatieprogramma.

Na de installatie kan de plugin worden gepubliceerd wanneer dit nog niet automatisch is gebeurd.

Open vervolgens de pluginconfiguratie vanuit:

**Systeem → Plugins → SimpleHealthMonitor**

> Screenshot pluginbeheer

Eerste configuratie

Voor het gebruik van de plugin zijn slechts twee instellingen noodzakelijk.

Storingsdrempel

De storingsdrempel (treshold) bepaalt vanaf welke totale score de website als ongezond wordt beschouwd.

Een lage waarde maakt de controle gevoeliger.

Een hogere waarde staat toe dat kleine problemen aanwezig zijn zonder dat de complete website als ongezond wordt beschouwd.

Health Token

Het Health Token beveiligt het JSON Health Endpoint.

Gebruik altijd een uniek en moeilijk te raden token.

Dit token wordt gebruikt door externe monitoringsoftware om de gezondheid van de website op te vragen.

Vergeet bij eerste gebruik niet om de instellingen op te slaan!

De Statuspagina

Na het opslaan verschijnt de actuele status van de website.

De statuspagina toont onder andere:

de algemene Health Status;
de huidige Health Score;
de ingestelde threshold;
het beveiligde Health Endpoint;
de resultaten van alle Health Checks.

Health Checks

Iedere Health Check controleert één specifiek onderdeel van Joomla.

De controles zijn onafhankelijk van elkaar.

Content Check

Controleert of de frontend van de website correct bereikbaar is.

Wanneer de homepage niet betrouwbaar kan worden gecontroleerd, wordt de status **UNKNOWN** weergegeven.

Mogelijke oorzaken zijn bijvoorbeeld lokale ontwikkelomgevingen of netwerkproblemen.

Mail Check

Controleert of Joomla e-mail kan verzenden.

Bij een probleem wordt aanvullende informatie weergegeven, inclusief eventuele SMTP-foutmeldingen.

Wanneer mogelijk wordt tevens een directe actie aangeboden om de Joomla Mail-instellingen te openen.

Scheduler Check

Controleert of de Joomla Scheduler actief is.

Wanneer geplande taken niet tijdig worden uitgevoerd, wordt aangegeven welke taken aandacht nodig hebben.

Ook kan direct worden genavigeerd naar de Scheduler binnen Joomla.

Statussen

Iedere Health Check gebruikt één van drie statussen.

OK

De controle is succesvol uitgevoerd.

Er is geen probleem vastgesteld.

FAILED

De controle heeft een probleem gevonden.

Afhankelijk van de ingestelde penalty verhoogt dit de totale Health Score.

UNKNOWN

De controle kon geen betrouwbaar resultaat bepalen.

Een UNKNOWN-status verhoogt de Health Score nooit.

Health Score

Iedere Health Check kan een penalty toevoegen aan de totale Health Score.

De Health Score is de som van alle penalties.

Wanneer de ingestelde threshold wordt bereikt of overschreden, wordt de website als ongezond beschouwd.

Hierdoor kunnen meerdere kleine problemen gezamenlijk leiden tot een ongezonde status.

Health Endpoint

SimpleHealthMonitor publiceert een beveiligd JSON-endpoint.

De exacte URL wordt automatisch weergegeven binnen de pluginconfiguratie.

Bijvoorbeeld:

https://example.com/?healthcheck=<token

Dit endpoint kan worden gebruikt door externe monitoringsoftware.

De plugin gebruikt de volgende HTTP-statuscodes.

HTTP	BetekenisOngeldig Health Token
200	Website is gezond \|
403	Ongeldig Health Token
503	Health Score overschrijdt de ingestelde threshold

Gebruik met monitoringsoftware

Vrijwel iedere monitoringoplossing die HTTP-verzoeken ondersteunt kan het Health Endpoint gebruiken.

Veelgebruikte voorbeelden zijn:

Gebruik hiervoor de volledige Endpoint URL zoals weergegeven in de pluginconfiguratie.

Aanbevolen werkwijze

Voor de meeste websites is de volgende werkwijze voldoende.

Stel direct na installatie een uniek Health Token in.
Kies een passende Health Score Threshold.
Controleer regelmatig de statuspagina.
Gebruik het Health Endpoint in een externe monitoringdienst.
Los FAILED-meldingen op voordat de totale Health Score de threshold bereikt.

Veelgestelde vragen

Waarom krijg ik een UNKNOWN-status?

Een UNKNOWN-status betekent dat de controle geen betrouwbaar resultaat kon bepalen.

Dit is geen foutmelding en verhoogt de Health Score niet.

Moet ik alle FAILED-meldingen direct oplossen?

Dat hangt af van de ingestelde Health Score Threshold.

Kleine problemen kunnen acceptabel zijn zolang de totale Health Score onder de threshold blijft.

Kan ik het Health Endpoint uitschakelen?

Ja.

Wanneer geen geldig Health Token is ingesteld, kan het endpoint niet worden gebruikt.