OPNsense Gateway Healthcheck – A Dockerized Monitoring Helper Tool

Überwache deine OPNsense Gateways ganz einfach!

Hey! 👋 Du nutzt OPNsense und möchtest deine Gateways im Blick behalten? Dann habe ich genau das Richtige für dich: OPNsense Gateway Healthcheck. Dieses Projekt macht es super einfach, den Status deiner Gateways zu überwachen – egal ob Internetdienstanbieter (ISP) oder VPN-Gateways. 🎯

Warum dieses Tool?

OPNsense ist großartig, aber manchmal fehlt die Übersicht, ob ein Gateway online ist oder nicht. Genau hier setzt dieses Tool an. Es bietet dir eine einfache Möglichkeit, den Status deiner Gateways zu prüfen und Probleme frühzeitig zu erkennen.

Was kann das Tool?

Mit OPNsense Gateway Healthcheck kannst du:

• Gesundheitsstatus prüfen: Sieh auf einen Blick, ob deine Gateways online sind.
• Individuelle Abfragen: Frage den Status eines Gateways per Name oder IP-Adresse ab.
• Listenansicht: Erhalte eine Liste aller gesunden oder ungesunden Gateways.
• Flexibilität: Unterstützt sowohl ISP- als auch VPN-basierte Gateways.

Wie funktioniert’s?

Das Tool nutzt die OPNsense-API, um den Status deiner Gateways abzufragen. Alles, was du tun musst, ist:

1. Einen API-Schlüssel in OPNsense erstellen.
2. Den Docker-Container starten – und fertig! 🚀

Wichtige Hinweise

• Gateway-Monitoring aktivieren: Stelle sicher, dass das Monitoring in OPNsense für die zu überwachenden Gateways aktiviert ist.
• Schwellenwerte konfigurieren: Der Offline-Status basiert auf den Schwellenwerten für Paketverlust und Latenz, die du in den erweiterten Einstellungen von OPNsense festlegen kannst.

API-Schlüssel erstellen

So erstellst du einen API-Schlüssel in OPNsense:

1. Gehe zur Benutzerverwaltung (system_usermanager.php).
2. Wähle einen Benutzer aus.
3. Scrolle nach unten zum Abschnitt API.
4. Klicke auf das +, um einen neuen Schlüssel zu erstellen.
5. Lade die Schlüsseldatei herunter – sie enthält deinen API-Schlüssel und das Secret.

Die Datei sieht so aus:

[API]
key = your-api-key
secret = your-secret-key

Mehr Infos findest du in der OPNsense API-Dokumentation.

Docker macht’s einfach

Dank Docker kannst du das Tool in wenigen Minuten starten. Hier ein Beispiel:

docker run -d -p 5000:5000 \
    -e API_KEY="your-api-key" \
    -e API_SECRET="your-secret-key" \
    -e OPNSENSE_BASE_URL="https://opnsense.example.com" \
    -e OPNSENSE_PORT="443" \
    --name opnsense-gateway-healthcheck laitco/opnsense-gateway-healthcheck

Danach erreichst du die Anwendung unter:

http://IP-ADDRESS_OR_HOSTNAME:5000/health

Integration in Gatus

Du kannst OPNsense Gateway Healthcheck ganz einfach in das Gatus Monitoring System integrieren, um den Status deiner Gateways zu überwachen. Hier ein Beispiel für die Konfiguration:

Beispielkonfiguration

endpoints:
  - name: example-gateway
    group: opnsense
    url: "http://IP-ADDRESS_OR_HOSTNAME:5000/health/examplegatewayname"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
      - "[BODY].healthy == true"
    alerts:
      - type: email
        failure-threshold: 2
        success-threshold: 3
        description: "Gateway ist offline!"
        send-on-resolved: true

Erklärung

• name: Ein beschreibender Name für das Gateway.
• group: Eine logische Gruppierung, z. B. opnsense.
• url: Die URL des Healthcheck-Endpunkts für ein spezifisches Gateway.
• interval: Wie oft der Check durchgeführt wird (z. B. alle 5 Minuten).
• conditions:
  • [STATUS] == 200: Stellt sicher, dass der HTTP-Statuscode 200 ist.
  • [BODY].healthy == true: Überprüft, ob das Gateway als gesund markiert ist.
• alerts:
  • type: Der Typ der Benachrichtigung (z. B. email).
  • failure-threshold: Anzahl der fehlgeschlagenen Checks, bevor eine Benachrichtigung ausgelöst wird.
  • success-threshold: Anzahl der erfolgreichen Checks, bevor die Benachrichtigung als gelöst markiert wird.
  • description: Beschreibung der Benachrichtigung.
  • send-on-resolved: Ob eine Benachrichtigung gesendet wird, wenn das Problem behoben ist.

Mit dieser Integration kannst du sicherstellen, dass du immer über den Status deiner Gateways informiert bist. 🚀

Fazit

Mit OPNsense Gateway Healthcheck hast du ein leistungsstarkes Tool, um deine Gateways im Blick zu behalten. Probier es aus und lass mich wissen, was du davon hältst! Feedback und Beiträge sind immer willkommen. 😊

GitHub-Repo ansehen

Viel Spaß beim Monitoring! 🚀