Healthchecks [ThoSch:Wiki]

Benutzer-Werkzeuge

Webseiten-Werkzeuge


thoschwiki:anwendungen:healthchecks

Healthchecks

Healthchecks ist eine Anwendung zum Monitoren von periodisch ausgeführten Tasks. Auf den zu überwachenden Instanzen laufen periodisch ausgeführte Task (z.B. reine „Ping“-Jobs, BackUp-Jobs), die den Call eines speziellen Webhooks der Healthchecks-Instanz beinhaltet. Sofern diese Call nicht im erwarteten Zeitrahmen erfolgt oder einen Fehlercode übermittelt, wird eine Meldung ausgelöst, die über diverse Kanäle erfolgen kann.

Healthchecks kann selbst gehostet oder als vom Entwickler betriebener Cloud-Service genutzt werden.

Software
Produkthomepage Healthchecks
GitHub healthchecks/healthchecks
Plattformen Linux
Linux-Paketierung nein, Installation über pip
Lizenz BSD-3-Clause License
Preis Nutzung der gehosteten Cloud-Lösung kostenpflichtig
Free-Tier vorhanden
weitere Informationen im Wiki
Healthchecks (Docker)

Installation

Die Installation ist in der Dokumentation beschrieben.

Konfiguration

Die Vorgabe der Konfiguration erfolgt über die Datei hc/settings.py (bzw. bei einem Betrieb in Docker mit dem Image inuxserver/docker-healthchecks innerhalb des Containers über die Datei /app/healthchecks/hc/local_settings.py oder deren Ablageort im Dateisystem des Docker-Hosts).

Für die Grundkonfiguration sind insbesondere die folgenden Variablen von besonderer Beudeutung:

Variable Bdeutung / Hinweis
SITE_NAME Name der Installation
SITE_ROOT Base-URL der Installation
PING_ENDPOINT Base-URL für die Ping-URLs der einzelnen Checks
Beispiel: PING_ENDPOINT = SITE_ROOT + "/ping/"
ALLOWED_HOSTS Liste der Host-/Domain-Namen, mit der der Server angesprochen werden kann.
Default ist * für alle Host-/Domain-Namen.
DEFAULT_FROM_EMAIL
EMAIL_HOST
EMAIL_PORT
EMAIL_HOST_USER
EMAIL_HOST_PASSWORD
EMAIL_USE_TLS (True/False)
Parameter für den eMail-Versand
EMAIL_USE_VERIFICATION (True/False) Steuert, ob für Mitteilungen vorgegebene eMail-Adressen durch einen Opt-In-Prozess verifiziert werden.
Sollte m.E. nur deaktiviert werden, wenn die Instanz alleine oder ausschließlich mit vertrauenswürdigen Benutzern betrieben wird.
SECRET_KEY Geheimer Schlüssel, der für die Verschlüsselung benutzt werden. Sollte mit einer zufälligen Zeichenkette gesetzt werden.
Per Default ist diese Variable nicht gesetzt.
DEBUG (True/False) Steuert den Debug-Mode und sollte im laufen Betrieb deaktiert werden.
Defaut ist jedoch True.
REGISTRATION_OPEN (True/False) Wichtig: Mit REGISTRATION_OPEN = True (Defaulwert!) ist eine Registration für Dritte auf dem Server möglich.
Sofern man den Server nicht für die Öffentlichkeit zur Verfügung stellen möchte, muss man REGISTRATION_OPEN = False setzen.

Sämtliche Werte sind in der Server-Dokumentation beschrieben.

Quellen

thoschwiki/anwendungen/healthchecks.txt · Zuletzt geändert: 18.07.2021 09:37 von thosch