Berichte (Reports)

Um Berichten einen Kontext zu geben, sie also mit Daten bestimmter Hosts und Services zu füllen, gibt es verschiedene Möglichkeiten. Daraus resultiert dann auch, dass die Berichte unterschiedlich aufgerufen werden müssen, um sinnvolle Informationen zu enthalten. Fehlt der Kontext, also die Angabe, welche Hosts und Services in den Bericht einfließen sollen, so bekommen Sie statt einer korrekten Ausgabe nur rot hervorgehobene Fehlermeldungen:

Der Unterschied besteht darin, an welcher Stelle der Kontext festgelegt wird:

Denken Sie nun nochmal an das oben erwähnte Snapin Reporting: Hierüber gelangen Sie ohne weitere Vorauswahl / Einschränkung etc. direkt zu den gerenderten Berichten. Sinnvoll sind hier also eigentlich nur solche Berichte, die einen eingebauten Kontext haben. Berichte, deren Kontext erst über (gefilterte) Ansichten entsteht, können Sie daher getrost über die Option Hide this report in the monitor menu aus dem Monitor-Menü sowie dem Snapin ausschließen.

Für die Bearbeitung eigener Berichte können Sie auf folgende Funktionen zurückgreifen:

Eine Beschreibung der unterschiedlichen Möglichkeiten folgt in den weiteren Abschnitten.

Ein wenig komplexer wird es nun, wenn Sie anstelle einer Berichtskopie einen komplett neuen Bericht erstellen wollen. Als Beispiel erstellen Sie im Folgenden eine einfache Übersicht über alle problematischen Services Ihrer Instanz, d.h. alle Services im Status WARN, CRIT oder UNKNOWN. Diese Übersicht wird den Titel „critical_services“ tragen.

Einen neuen Bericht legen Sie auf der Seite Edit Reports über Reports > Add report an.

Im ersten Schritt lassen Sie den Filter Select specific object type auf der Auswahl No restrictions to specific objects stehen und wechseln direkt mit Continue zur nächsten Auswahl.

Wie beim Kopieren eines bestehenden Berichts geben Sie auch hier zuerst Unique ID und Title an:

Im Abschnitt Context / Search Filters wählen Sie nun unter Service die Service states aus. Nach einem Klick auf Add filter können Sie die gewünschten Zustände festlegen:

Mit Save & go to list wird der neue Bericht in den Abschnitt Customized der Übersichtsliste der Berichte aufgenommen.

Wenn Sie diesen Bericht jetzt in freudiger Erwartung aufrufen, ist das Ergebnis ernüchternd. Die Berichtsseite hat zwar ein erstes Layout und auch eine Überschrift, ist aber ansonsten leer. Nicht gerade das Ergebnis, mit dem man seinen Chef beeindrucken kann …​

Deshalb muss nun die Gestaltung des Inhalts für den Bericht definiert werden. Über das Symbol gelangen Sie zur Inhaltsfestlegung für den Bericht. Die Auswahl von Berichtselementen erfolgt dreistufig, jeweils mit einem Klick auf Continue dazwischen.

Beginnen Sie mit einem Klick auf Add content. Wählen Sie für dieses Beispiel in Step 1 den Elementtyp Availability table. Setzen Sie Step 2 auf die Auswahl All services und Step 3 auf die Auswahl No restrictions to specific objects. Die weiteren Optionen der nachfolgenden Seite lassen Sie für den Moment erst einmal unverändert. Stattdessen klicken Sie direkt auf Save. Betrachten Sie nun die Vorschau auf Ihren Bericht:

Auf der linken Seite sehen Sie die Vorschau, hier für den Bericht critical_services. Rechts daneben werden die Elemente des Berichts in einer Liste angezeigt. Diese Elemente werden mit den Symbolen bearbeitet, kopiert, gelöscht und umsortiert.

Diesen einfachen, selbst erstellten Bericht können Sie nun flexibel um weitere Elemente erweitern (siehe unten) und jederzeit, z. B. aus der Seitenleiste heraus, aufrufen.

In beinahe jedem Schritt der Berichtserstellung gibt es die Möglichkeit, die Inhalte an Ihre Bedürfnisse anzupassen.

Im ersten Schritt können Sie einen Filter setzen und den Bericht von vornherein auf einen bestimmten Host oder eine bestimmte Datenquelle beschränken, etwa Netzwerkschnittstellen, BI-Aggregate, Sensoren und so weiter:

Als nächstes tragen Sie wieder die Unique ID und den Title ein. Für den Titel können Sie auch die mitgelieferten Makros (=Textbausteine) nutzen. Wählen Sie als nächstes ein Icon, mit dem der Bericht in den Menüs sichtbar sein soll. Durch die Einstellung der Option Make this report available for other users auf die Kontaktgruppe, im Beispiel check-mk-notify, geben Sie den zugehörigen Gruppenmitgliedern die Möglichkeit, den Bericht jederzeit eigenständig aufzurufen und sich selbstständig zu informieren.

Im Kasten Context / Search Filters stehen Ihnen wie üblich umfangreiche Filtermöglichkeiten zur Verfügung, von bestimmten Hosts über einzelne Docker-Container bis hin zu Werten aus der Oracle-Überwachung.

Für dieses Beispiel ist die Host-Auswahl auf einen Ordner beschränkt und zusätzlich auf festgelegte Host-Probleme. Diese Einschränkung beschleunigt, gerade in komplexeren Umgebungen, die Datenabfrage.

Mit Save & go to list gelangen Sie zur Berichtsübersicht. Als nächstes geht es an die Ausgestaltung des Berichtsinhalts.

Mit Hilfe des Symbols gelangen Sie zur inhaltlichen Gestaltung:

Öffnen Sie mit Reports > Add content die Bearbeitung des Berichtsinhalts. Hiermit fügen Sie beispielsweise Tabellen, Graphen, Inhaltsverzeichnisse oder Texte (auch via Makros oder HTTP) in den Bericht ein. Diese Inhalte erscheinen nacheinander und bestimmen so auch die finale Länge des Berichts.

Wählen Sie in Schritt 1 (Step 1) das gewünschte Element aus, für dieses Beispiel Multiple graphs. Damit erhalten Sie, abhängig von Ihren weiteren Einstellungen, mehrere gleichartige Grafiken untereinander. So können Sie zum Beispiel den direkten Vergleich zwischen den Zuständen mehrerer Hosts abbilden.

Fahren Sie mit Continue fort. Als Datenquelle für die Grafiken wählen Sie in Schritt 2 für dieses Beispiel All services, d.h. alle auf den Hosts laufenden Services:

Fahren Sie mit Continue fort. In Schritt 3 könnten Sie nun die anzuzeigende Datenmenge beschränken. Dies wird für das aktuelle Beispiel nicht benötigt. Wieder wechseln Sie mit Continue zur nächsten Auswahl.

Für den Beispielbericht legen Sie im Kasten Properties unter Graph layout fest, dass Sie für die Grafiken jeweils einen Titel sehen wollen, bestehend aus dem Grafiktitel, dem Host-Namen und der Service-Beschreibung. Zudem setzen Sie die angezeigte Zeitspanne unter Graph time range auf vier Stunden.

Im Kasten Context / Search Filters schränken Sie den Bericht auf festgelegte Host- oder Service-Merkmale ein. Hier wählen Sie diesmal CPU utilization für den Service aus.

Mit einem Klick auf Save haben Sie das erste Berichtselement fertiggestellt.

Für die zweite Grafik im Beispiel beginnen Sie wieder mit Reports > Add content und wählen in Step 1 die Option Metrics graph of a single service. Wechseln Sie mit Continue zu Step 2 und beschränken Sie die Suchfilter auf Host-Name und Service-Beschreibung:

Mit einem Klick auf Save ist auch das zweite Berichtselement fertig.

Als drittes Element erstellen Sie eine Übersicht aktueller Alarmierungen. Das Vorgehen bleibt wie gehabt:

Mit einem Klick auf Save ist auch dieses Berichtselement fertig.

Um die Darstellung übersichtlicher zu gestalten, fügen Sie noch Überschriften ein:

Öffnen Sie mit Reports > Add content die Bearbeitung des Berichtsinhalts. Wählen Sie in Step 1 als Elementtyp Heading. Wechseln Sie mit Continue zu Step 2. Optional können Sie eine Hierarchieebene für die Überschrift angeben. Tragen Sie die Überschrift bei The text ein.

Mit einem Klick auf Save kehren Sie zur Übersicht zurück. Die neue Überschrift befindet sich jetzt jedoch in der Reihenfolge unterhalb der Grafiken. Klicken Sie daher in der Liste der Inhaltselemente auf das entsprechende und verschieben Sie die Überschrift an die gewünschte Position in der Liste.

Tipp: In der Vorschau sehen Sie möglicherweise rote Zeilen und Fehlermeldungen statt echter Daten — denn an diesen Stellen fehlt dem Bericht im Editor der Kontext, hier also etwa die Angabe eines Hosts, der sich erst über den Aufruf des Berichts aus einer entsprechenden Ansicht ergeben würde. Wenn Sie eine brauchbare Vorschau sehen wollen, filtern Sie einfach in den Berichtseinstellungen im Bereich Context / Search Filters zwischenzeitlich auf einen bestimmten Host. Das macht das Gestalten deutlich einfacher.

Um den Bericht zu strukturieren, gibt es ergänzende Gestaltungselemente: Horizontale Linie, Bild, Seitenrahmen und eine einzelne Textzeile. Diese Bausteine können Sie auf allen oder bestimmten Seiten Ihres Berichts anzeigen lassen.

Für den Beispielbericht fügen Sie einen Rahmen um den Bericht ein. Auch hier erfolgt die Definition wieder schrittweise, jeweils fortgesetzt mit einem Klick auf . Beginnen Sie mit Reports > Add page element.

Da der Rahmen auf allen Seiten sichtbar sein soll, erfordert der nächste Schritt keine Änderungen:

Der neue Seitenrahmen wird nun in der Übersicht angezeigt, sowohl in der Vorschau links als auch in der Tabelle der statischen Seitenelemente rechts.

Tipp: Die in Checkmk vorhandenen Makros (=Textbausteine) können Sie zum Beispiel auch nutzen, um noch eine Fußzeile mit Seitenzahl und Namen des Berichts zu erstellen. Wählen Sie dazu das Seitenelement One line of text und geben Sie im zweiten Schritt die Position am unteren Seitenende sowie den Text inklusive der gewünschten Makros an:

Mit einem hochwertigeren Erscheinungsbild, z.B. mit dem Firmenlogo versehen, wirken Berichte gleich ansprechender.

Öffnen Sie mit Reports > Edit properties die Berichtseinstellungen:

Im zweiten Kasten finden Sie hier die Report Properties. An dieser Stelle konfigurieren Sie Werte für Schrift, Seitenformat, Zeit- und Datumseinstellungen, das Berichtslayout und den Dateinamen bei Downloads.

Kopieren Sie Ihr Firmenlogo in das Verzeichnis ~/local/share/check_mk/reporting/images/ und speichern Sie es als Datei logo_mk.png. Ab sofort wird dieses Logo auf allen Berichten angezeigt.

Hinweis: Aktuell passen Sie die bestehende Berichtsvorlage an Ihre Bedürfnisse an. Alternativ können Sie auch eine komplette, neue Berichtsvorlage entsprechend Ihren Firmenvorgaben erstellen, z.B. um das Corporate Design des Unternehmens abzubilden.

Öffnen Sie mit Scheduled reports > Add schedule einen neuen Plan, wählen Sie dann den Bericht aus und klicken Sie Continue.

Im Kasten General Options legen Sie Grundeinstellungen wie Titel, Erstellungszeit, Berichtszeitraum und so weiter fest:

Unter Context / Search Filters finden Sie die üblichen Filtermöglichkeiten, abhängig vom gewählten Bericht. Speichern Sie den Plan anschließend, um zur Liste Ihrer geplanten Berichte zurückzukehren.

In der Liste finden Sie auch Informationen darüber, wann der Bericht zum letzten Mal erzeugt/versandt wurde, ob dabei ein Fehler aufgetreten ist, wann er das nächste Mal erzeugt/versendet wird und einiges mehr (hier leicht gekürzt):

Einträge in der Liste werden über die fünf Symbole am Anfang eines Eintrags verwaltet:

Hinweis: Versendete Berichte werden nicht in der Instanz gespeichert.

Statt den Bericht zu versenden, können Sie diesen auch lokal ablegen. Wählen Sie dafür Action - Store locally:

Legen Sie dann einen Dateinamen und optional einen Berichtstitel fest. Um eine Historie der Berichte aufbauen zu können - anstatt bei jeder Erstellung des Berichts die Vorgängerversion zu überschreiben, bietet Checkmk diverse Makros (=Textbausteine) an.

Die Übersicht aller lokal gespeicherten Berichte können Sie im Fenster Edit Reports über den Menüeintrag Reports > Stored reports aufrufen:

Inhaltselemente werden aufgelistet, wenn Sie bei der Bearbeitung eines Berichts Reports > Add content auswählen.

Seitenelemente werden aufgelistet, wenn Sie bei der Bearbeitung eines Berichts Reports > Add page element auswählen.