Terug naar blog

Shopware

FroshTools Health in Zabbix: ons nieuw open-source template

Door Rune Laenen 4 min leestijd

Wie met Shopware werkt, kent waarschijnlijk FroshTools, de plugin van Friends of Shopware. Hij staat op zo goed als elke shop die we beheren. Een van de handigste onderdelen is de kaart Health status in de admin. Daar zie je in één oogopslag of je PHP-versie nog ondersteund is, of de message queue niet vastzit, of de scheduled tasks nog lopen en of je MySQL-instellingen kloppen.

Het probleem is dat die kaart alleen iets zegt aan wie ze opent. En niemand opent elke ochtend de admin van elke shop om te kijken of alles nog groen is. Een vastgelopen queue of een scheduled task die al dagen niet meer gedraaid heeft, merk je dan pas als er iets anders begint te haperen: mails die niet vertrekken, een index die niet meer bijwerkt, een sitemap die verouderd is.

Daarom hebben we een Zabbix-template gebouwd dat die health checks automatisch opvolgt. Het staat open source op GitHub: runelaenen/FroshToolsZabbix.

Waarom niet gewoon de server monitoren?

Dat doen we ook, maar het volstaat niet. CPU, geheugen, disk en uptime vertellen je of de server technisch in orde is. Ze vertellen je niet of Shopware zijn werk doet. Een shop kan perfect bereikbaar zijn en een HTTP 200 teruggeven terwijl de queue al uren niets meer heeft verwerkt.

Die kennis zit al ingebakken in FroshTools. De plugin weet welke checks er bestaan, wat de aanbevolen waarde is en wat de huidige waarde is. Het leek ons zonde om dat in Zabbix allemaal opnieuw te bouwen. Dus lezen we gewoon uit wat FroshTools zelf al berekent.

Het is hetzelfde idee als bij onze monitoring van productfeeds: niet alleen kijken of iets bereikbaar is, maar of het ook doet wat het moet doen.

Wat je nodig hebt

Onderdeel Versie
Zabbix server / proxy 7.0 of nieuwer
Shopware 6.6 of 6.7
FroshTools 3.x, met het /health/status-endpoint

Opzetten in vijf minuten

De volledige stappen staan in de README, maar in het kort:

  1. Installeer FroshTools in Shopware, als dat nog niet gebeurd is.
  2. Maak een read-only rol aan met enkel de permissie Frosh Tools → Viewer.
  3. Maak een integratie aan met die rol. Noteer de access key ID en de secret.
  4. Importeer onze template in Zabbix.
  5. Maak een host aan, koppel de template en vul de drie macro's in: {$SHOPWARE.URL}, {$SHOPWARE.CLIENT_ID} en {$SHOPWARE.CLIENT_SECRET}.

Checks stilzetten

Niet elke warning is een probleem. Soms draait een shop bewust een PHP-build van de distributie die de security fixes wel bevat, ook al ziet het versienummer er oud uit. Zo'n check wil je niet elke vijf minuten zien opduiken.

Dat kan op twee manieren. Onze voorkeur gaat naar FroshTools zelf, omdat de beslissing dan in de shop gedocumenteerd staat:

frosh_tools:
    checker:
        acknowledged_checks:
            php-version: "Distro PHP build includes the security fixes"
        disabled_checks:
            - system-time

Een acknowledged check zakt naar INFO, met een verplichte reden erbij. Onze integratie maakt er dan geen probleem meer van. Een disabled check verdwijnt helemaal, en Zabbix schakelt de items ervan gewoon uit.

Kan of wil je niet aan de shopconfig komen, dan kan je dit ook in Zabbix configureren door de macro {$FROSH.CHECK.NOT_MATCHES} in te stellen op een regex van check-id's, bijvoorbeeld ^(system-time|queue)$.

Open source, en bijdragen zijn welkom

We hebben de template gepubliceerd onder de MIT-licentie op GitHub. We gebruiken het zelf op de shops van onze klanten die we beheren. Loop je tegen iets aan of heb je een verbetering, open dan gerust een issue of pull request.

Wil je dat iemand de monitoring van je Shopware-shop mee opvolgt, zonder dat je zelf een Zabbix-server moet draaien? Bekijk dan Care, of neem contact op en we bekijken samen wat je shop nodig heeft.

Laten we praten

Een e-commerce project in gedachten?

Wij zijn een boutique e-commerce bureau. Vertel ons wat je bouwt en we helpen je sneller vooruit.