Ergebnistexte für eigene Checks gestalten

Scriban-Vorlagen für kompakte Check-Zusammenfassungen und ausführliche Meldungstexte erstellen.

Ein eigener Check kann neben seinen Messwerten einen verständlichen Kurztext und eine ausführliche Beschreibung liefern. Der Kurztext wird für kompakte Benachrichtigungen und Übersichten genutzt, der ausführliche Text für interne und externe Meldungen. Die Vorlagen ändern die Darstellung, nicht den vom Check ermittelten Status.

Voraussetzungen

Du brauchst einen eigenen Check mit definiertem Ausgabe-Schema und die Berechtigung zum Verwalten eigener Checks. Für einen Live-Test brauchst du außerdem ein geeignetes Gerät und die Berechtigung, dort Skripte auszuführen. Die reine Textvorschau führt kein Skript aus.

Vorlagen bearbeiten

  1. Öffne deinen eigenen Check im Editor und wechsle zu Ergebnistext.
  2. Wähle die Sprache. Pflege mindestens Englisch als Rückfalltext, wenn eine andere Sprache fehlt.
  3. Trage eine Scriban-Vorlage unter Kurztext und Ausführlicher Text ein. Verwende Ausgabeschlüssel aus deinem Check, keine Bezeichnungen aus dem Layout.
  4. Wähle Vorschau und prüfe Erzeugter Text. Die Vorschau nutzt die Ausgabe des letzten Live-Tests, sofern vorhanden, sonst Beispieldaten aus dem Ausgabe-Schema. Prüfe auch Warnungs-, Fehler- und leere Ergebnisse mit passenden Testdaten, bevor du den Check breit zuweist.
  5. Korrigiere gemeldete Vorlagenfehler und wähle Speichern. Die Vorschau allein speichert die Vorlagen nicht.

Der Ergebnistext-Editor eines eigenen Checks mit Kurztext, ausführlichem Text, Sprachauswahl und Vorschau

Beispiel

Gibt dein Check eine Zahl usedPercent aus, kannst du in beiden Sprachvorlagen zum Beispiel Folgendes verwenden:

{{ format.status status }} — {{ format.percent output.usedPercent 1 }}

Der Status und die Zahl werden für die gewählte Sprache formatiert. usedPercent muss tatsächlich im Ergebnis stehen. format.percent erwartet bereits einen Prozentwert: 85 wird als 85 % ausgegeben, nicht 0,85.

AusdruckVerwendung
output.<key>Feld aus der vollständigen Check-Ausgabe; auch Listen und verschachtelte Objekte sind verfügbar
statusNumerischer Gesamtstatus des Checks
status_nameTechnischer Statusname; für lokalisierten Text besser format.status status verwenden
format.bytes output.freeSpaceBytewert lesbar formatieren
format.number output.value 1Zahl mit der angegebenen Anzahl Nachkommastellen (0 bis 6)
format.percent output.usedPercent 1Zahl als Prozentwert formatieren, ohne sie mit 100 zu multiplizieren
format.text output.message 120Text auf eine Zeile zusammenfassen und auf die angegebene Länge kürzen

Grenzen und Fehlersuche

Schreibe Klartext, kein HTML. Für HTML-basierte Integrationen wird der Text sicher kodiert. Eine leere oder ungültige Vorlage fällt auf den allgemeinen Ergebnistext zurück; sie unterdrückt keinen Alarm. Stimmt die Vorschau nicht mit dem erwarteten Text überein, prüfe zuerst, ob echte Live-Testdaten oder Schema-Beispieldaten verwendet wurden und ob jeder referenzierte Schlüssel im Ergebnis vorhanden ist.

Eingebaute Checks liefern bereits eigene Ergebnistexte mit. Dafür musst du keine Kopie erstellen oder Vorlage pflegen.

Vorlagen über MCP pflegen

Ein autorisierter MCP-Client kann die Vorlagen mit get_custom_check lesen und mit create_custom_check oder update_custom_check pflegen. textRenderer enthält die nach Sprache gegliederten Scriban-Vorlagen short und long; Messwerte stehen unter output bereit. Zum Ändern sind Lese- und Schreibfreigabe sowie die Berechtigung zur Verwaltung eigener Checks nötig. Prüfe den erzeugten Text anschließend in der Vorschau des Editors, bevor du den Check zuweist.

Verwandte Artikel