Reguläre Ausdrücke in Checkmk

Bei den regulären Ausdrücken geht es immer darum, ob ein Muster ("Pattern", beziehungsweise der reguläre Ausdruck) auf einen bestimmten Text (z.B. einen Service-Namen) passt (matcht). Der einfachste Anwendungsfall sind Ketten alphanumerischer Zeichen. Diese (und das als Bindestrich verwendete Minus-Zeichen) im Ausdruck matchen einfach sich selbst.

Beim Suchen in der Monitoring-Umgebung unterscheidet Checkmk dabei in der Regel nicht zwischen Groß- und Kleinschreibung. Der Ausdruck CPU load matcht also in den meisten Fällen auf den Text CPU load genauso wie auf cpu LoAd. Beim Suchen in der Konfigurationsumgebung dagegen wird üblicherweise zwischen Groß- und Kleinschreibung unterschieden. Begründete Ausnahmen von diesen Standards sind möglich und werden in der Inline-Hilfe beschrieben.

Achtung: Bei Eingabefeldern, in denen ohne reguläre Ausdrücke ein exakter Match vorgesehen ist (meistens bei Host-Namen), wird Groß- und Kleinschreibung immer unterschieden!

Neben den "Klartext"-Zeichenketten gibt es eine Reihe von Zeichen und Zeichenfolgen, die "magische" Bedeutung haben. Das wichtigste derartige Zeichen ist der . (Punkt). Er matcht genau ein einziges beliebiges Zeichen:

Sehr häufig möchte man definieren, dass eine Folge von Zeichen bestimmter Länge vorkommen darf. Hierfür gibt man in geschweiften Klammern die Zahl der Wiederholungen des vorhergehenden Zeichens an:

Für die letzten drei Fälle gibt es Abkürzungen: * matcht das vorhergehende Zeichen beliebig oft, + matcht ein mindestens einmaliges Auftreten und ? matcht das höchstens einmalige Auftreten.

Sie können auch den Punkt . mit den Wiederholungsoperatoren verknüpfen, um eine Folge beliebiger Zeichen definierter zu suchen:

Zeichenklassen erlauben es, bestimmte Ausschnitte des Zeichensatzes zu matchen, beispielsweise „hier muss eine Ziffer kommen“. Dafür setzen Sie alle zu matchenden Zeichen innerhalb eckiger Klammern. Mit einem Minuszeichen können Sie auch Bereiche angeben. Hinweis: es gilt dabei die Reihenfolge im 7-Bit-ASCII-Zeichensatz.

So steht beispielsweise [abc] für genau eines der Zeichen a, b oder c und [0-9] für eine beliebige Ziffer - beides lässt sich kombinieren. Auch eine Negation des Ganzen ist möglich: Mit einem ^ in der Klammer steht [^abc] dann für ein beliebiges Zeichen außer a, b, c.

Zeichenklassen lassen sich natürlich mit anderen Operatoren kombinieren. Zunächst mal einige abstrakte Beispiele:

Dazu einige praktische Beispiele:

Hinweis: Wenn Sie eines der Zeichen -, [ oder ] brauchen, müssen Sie etwas tricksen. Das - (Minuszeichen) schreiben Sie ans Ende der Klasse — wie im letzten Beispiel bereits gezeigt. Beim Auswerten der regulären Ausdrücke wird das Minuszeichen, wenn es nicht mittleres von drei Zeichen ist, nicht als Operator, sondern als exakt dieses Zeichen ausgewertet. Eine schließende eckige Klammer platzieren Sie als erstes Zeichen in der Klasse, eine öffnende gegebenenfalls als zweites Zeichen. Da keine leeren Klassen erlaubt sind, wird die schließende eckige Klammer dann als normales Zeichen interpretiert. Eine Klasse mit diesen Sonderzeichen sähe also so aus: []-], beziehungsweise [][-] wenn auch die öffnende eckige Klammer benötigt wird.

In vielen Fällen ist es erforderlich, zwischen Matches am Anfang, am Ende oder einfach irgendwo innerhalb einer Zeichenkette zu unterscheiden. Für den Match des Anfangs einer Zeichenkette (Präfix-Match) verwenden Sie den ^ (Zirkumflex), für das Ende (Suffix-Match) das $ (Dollarzeichen). Ist keines der beiden Zeichen angegeben, ist bei den meisten Bibliotheken für reguläre Ausdrücke Infix-Match Standard — es wird an beliebiger Stelle in der Zeichenkette gesucht. Für exakte Matches verwenden Sie sowohl ^ als auch $.

Hinweis: Im Monitoring und der Event Console ist Infix-Match Standard. Ausdrücke, die irgendwo im Text vorkommen, werden gefunden, d.h. die Suche nach "memory" findet auch "Kernel memory". In der Setup-GUI dagegen prüft Checkmk beim Vergleichen von regulären Ausdrücken mit Service-Namen und anderen Dingen grundsätzlich, ob der Ausdruck mit dem Anfang des Textes übereinstimmt (Präfix-Match) – in der Regel ist dies, was Sie suchen:

Falls Sie an Stellen, an denen Präfix-Match vorgesehen ist, doch einmal einen Infix-Match benötigen, erweitern Sie einfach Ihren regulären Ausdruck am Anfang mit .*, um eine beliebige vorangestellte Zeichenkette zu matchen:

Tipp: Sie können jede Suche am Anfang einer Zeichenkette mit ^ und jede Suche innerhalb mit .* einleiten, die Interpreter für reguläre Ausdrücke ignorieren redundante Symbole.

Da der Punkt alles matcht, matcht er natürlich auch einen Punkt. Wenn Sie nun aber genau einen Punkt matchen wollen, so müssen Sie diesen mit einem \ (Backslash) maskieren (eingedeutscht: „escapen“). Das gilt analog auch für alle anderen Sonderzeichen. Dies sind: \ . * + ? { } ( ) [ ] | & ^ und $. Der \ Backslash wertet das nächste dieser Sonderzeichen als normales Zeichen:

Achtung Python: Da in Python der Backslash in der internen Zeichenkettendarstellung intern mit einem weiteren Backslash maskiert wird, müssen diese beiden Backslashes wiederum maskiert werden, was zu insgesamt vier Backslashes führt:

Mit dem senkrechten Strich | können Sie Alternativen definieren, sprich eine ODER-Verknüpfung verwenden: 1|2|3 matcht also 1, 2 oder 3. Wenn Sie die Alternativen inmitten eines Ausdrucks benötigen, gruppieren Sie diese innerhalb runder Klammern.

Match-Gruppen (englisch match groups oder capture groups) erfüllen zwei Zwecke: Der erste ist — wie im letzten Beispiel gezeigt — die Gruppierung von Alternativen oder Teil-Matches. Dabei sind auch verschachtelte Gruppierungen möglich. Zudem ist es zulässig, hinter runden Klammern die Wiederholungsoperatoren *, +, ? und {…​} zu verwenden. So passt der Ausdruck (/local)?/share sowohl auf /local/share als auch auf /share.

Der zweite Zweck ist das "Einfangen" gematchter Zeichengruppen in Variablen. In der Event Console (EC), Business Intelligence (BI), beim Massenumbenennen von Hosts und bei Piggyback-Zuordnungen besteht die Möglichkeit, den Textteil der dem regulären Ausdruck in der ersten Klammer entspricht, als \1 zu verwenden, den der zweiten Klammer entsprechenden als \2 usw. Das letzte Beispiel der Tabelle zeigt die Verwendung von Alternativen innerhalb einer Match-Gruppe.

Folgende Abbildung zeigt eine solche Umbenennung mehrerer Hosts. Alle Host-Namen, die auf den regulären Ausdruck server-(.*)\.local passen, werden durch \1.servers.local ersetzt. Dabei steht das \1 genau für den Text, der mit dem .* in der Klammer "eingefangen" wurde:

Im konkreten Fall wird also server-lnx02.local in lnx02.servers.local umbenannt.

Soll eine Match-Gruppe keine Zeichengruppen „einfangen“, beispielsweise wenn sie nur zur Strukturierung dient, kann mit ?: die Umwandlung in eine nicht einfangende Match-Gruppe (non-capturing match group) erfolgen: (?:/local)?/share.

Mit Inline Flags können bestimmte, den Modus der Auswertung betreffende Einstellungen innerhalb eines regulären Ausdrucks vorgenommen werden. Für die Arbeit mit Checkmk relevant ist vor allem (?i), welches bei Ausdrücken, die sonst mit Groß- und Kleinschreibung ausgewertet werden, auf ein Matching umschaltet, das Groß- und Kleinschreibung nicht berücksichtigt (case-insensitive). In sehr seltenen Fällen werden Sie für die Arbeit mit mehrzeiligen Strings auch (?s) und (?m) benutzen wollen.

Beachten Sie, dass Python seit Version 3.11 Inline Flags entweder am Anfang eines regulären Ausdruckes — (?i)somestring — oder unter Angabe des Geltungsbereiches — (?i:somestring) — erwartet. Da Checkmk in einigen Fällen aus Gründen besserer Performance reguläre Ausdrücke intern kombiniert, raten wir dringend, Inline Flags nicht am Anfang eines regulären Ausdruckes zu benutzen. Verwenden Sie stattdessen immer die Schreibweise mit Geltungsbereich – der sich im Zweifel auf den gesamten regulären Ausdruck erstreckt:

(?i:somestring)

Hierbei handelt es sich um eine Variante der nicht einfangenden Match-Gruppe.

Insbesondere, wenn Eigennamen in Kommentaren oder beschreibenden Texten per Copy und Paste übernommen wurde und daher Unicode-Zeichen oder verschiedene Typen von Leerzeichen im Text auftreten, sind Pythons erweiterte Klassen sehr hilfreich:

An Stellen, an denen Checkmk Unicode-Matching erlaubt, ist \w vor allem zur Suche nach ähnlich geschriebenen Worten in verschiedenen Sprachen hilfreich, beispielsweise Eigennamen, die mal mit und mal ohne Accent geschrieben werden: