Jan Haffner
08.10.2019

Die Weiterentwicklung der TYPO3 Caretaker Überwachung

TYPO3 Caretaker Überwachung

Wir nutzen zur Überwachung unserer TYPO3-Installationen schon viele Jahre TYPO3 Caretaker. Dabei werden unter anderem TYPO3-Updates und Erweiterungs-Updates automatisiert geprüft. Zu Caretaker gehören hauptsächlich zwei Erweiterungen, eine für den Server (caretaker) und eine für den Client (caretaker_instance). Zusätzlich gibt es noch Drittanbieter-Erweiterungen, die den Funktionsumfang erweitern. Wir verwenden zum Beispiel Caretaker Mattermost (caretaker_mattermost) von Nicole Cordes. Dadurch werden wir sofort in unserem Mattermost Channel benachrichtigt, sobald irgendwelche Probleme auftauchen.

Die Entwicklung stagnierte...

Leider stagnierte die Caretaker-Entwicklung in letzter Zeit sehr stark. Die Entwickler haben keine Zeit und keinen Bedarf die Erweiterungen im Moment zu pflegen und weiter zu entwickeln. Daher haben wir uns nach einer Alternative umgesehen, allerdings konnte uns keine der Möglichkeiten begeistern. Deshalb haben wir nach langem Überlegen entschieden, dass wir die Entwicklung selbst im Sinne von Open Source weiter voran treiben.

Und wie geht es weiter?

Wir haben nun Vollzugriff auf die Erweiterungen und werden uns zukünftig um Releases kümmern. Zentrale Anlaufstelle für die Entwicklung bleibt weiterhin das Projekt auf GitHub. Dort stehen neben den Erweiterungen zusätzlich zwei Entwicklungsumgebungen auf Basis von DDEV zur Verfügung, die für die Entwicklung und zum Testen genutzt werden können:

Alle bisherigen Entwickler haben weiterhin Zugriff auf das Projekt und können so jederzeit, falls gewünscht, zur Weiterentwicklung beitragen. Wir freuen uns natürlich auch über weitere Mitstreiter, die das Projekt bereichern. Jede Major-Version wird zwei TYPO3 LTS Versionen unterstützen. Für die Erweiterung caretaker_instance haben wir bereits zwei Releases (1.0.0 und 2.0.0) veröffentlicht. Vor Kurzem wurde die Version 1.0.0 der Erweiterung caretaker veröffentlicht, welche TYPO3 v7 und v8 unterstützt.

Test Service zur Überwachung der TYPO3 Reports (u.a. Solr)

TYPO3 bietet mit der System-Erweiterung "reports" einen "Status report". Hier gibt es u.a. Tests für Sicherheit und die System-Umgebung, außerdem können Erweiterungen (z.B. Solr) eigene Reports liefern. Caretaker greift hier auf diese Schnittstelle zu und meldet entsprechend Warnungen und Fehler aus diesem Status report. Im Test Service kann konfiguriert werden, wie Warnungen behandelt werden sollen (OK, Warnung, Fehler). Alle Status-Meldungen, die in Ordnung (grün) sind, werden im Caretaker nicht angezeigt, so dass es übersichtlich bleibt.

Test Service zur Überwachung von Blacklisted Records (FE-Users)

Caretaker bietet seit Längerem einen »Test Service« an, um Backend-Benutzername prüfen zu können. Diesen Test nutzt die dkd, wenn ein Mitarbeiter zum Beispiel die Firma verlässt. Der Benutzername wird der Liste hinzugefügt, um anschließend zu erkennen auf welchen TYPO3-Instanzen Accounts des Mitarbeiters vorhanden sind. Dieser Vorgang vereinfacht das Deaktivieren bzw. Löschen der Accounts. Bei uns im Unternehmen entstand an dieser Stelle die Idee, dieses Testingverfahren auch für die Frontend-Benutzer zu nutzen. Aus diesem Grund wurde ein neuer »Test Service« namens »Check blacklisted records« implementiert, mit dem beliebige TYPO3 Records überprüft werden können.


Update Februar 2023

Neue Version 3.1.0 der caretaker-instance-extension veröffentlicht. Diese Version bietet ausschließlich Kompatibilitätsanpassungen für TYPO3 11 (und PHP 8.x). Es ist parallel eine Version 4.0 für TYPO3 11/12 in Arbeit, die neue Features bringt und ausschließlich mit dem neuen Caretaker-Server laufen wird. Da dieser sich noch etwas zieht, wurde jetzt die Version 3.1.0 zwischen geschoben damit Caretaker in den TYPO3-11-Projekten eingesetzt werden kann bis der neue Server steht.

Die neue Version steht über Packagist zur Verfügung:
https://packagist.org/packages/caretaker/caretaker_instance#3.1.0