Zum Inhalt

Bearbeitung von Reportvorlagen

Voraussetzungen

Bearbeitung von Reports

  1. Öffnen Sie die Settings-App.
  2. Klicken Sie im Navigationsmenü auf den Eintrag "Report Vorlagen ".
  3. Suchen Sie aus der Liste die Reportvorlage heraus, das Sie bearbeiten wollen. Es stehen Ihnen nun folgende Operationen zur Verfügung:
Operation Beschreibung
Details Die Details zur Reportvorlage können abgerufen und bearbeitet werden.
Archivieren Nicht mehr benötigte Reportvorlagen können archiviert werden.

Details zur Reportvorlage

Mit einem Klick auf das Symbol werden die Details zur Reportvorlage aufgelistet.

Allgemeine Informationen

Nach der Erstellung der Reportvorlage können Sie weitere Einstellungen vornehmen, darunter Name und Standort.

Schlüsselwort Beschreibung Beispiel
Name Ein einfaches Textfeld zur Eingabe des Namens der Reportvorlage. Wochenreport
Standort Ein Suchfeld zur Eingabe des Standorts. Heidelberg

Konfiguration

In diesem Abschnitt werden die verschiedenen Konfigurationsoptionen für Reports beschrieben. Sie können den Zeitpunkt und die Zeitspanne für die Datenerfassung festlegen, die Aufbewahrungsdauer für Reports bestimmen und benutzerdefinierte Variablen für die Report-Erstellung festlegen oder überschreiben.

Zeitpunkt und Zeitspanne

Aus den Eigenschaften Zeitpunkt und Zeitspanne ergibt sich der Zeitraum der Daten für den Report, dabei stellt Zeitpunkt das Ende der Zeitspanne dar, von dem aus die gewählte Zeitspanne abgezogen wird.

Beispiel

Anhand eines Beispiels soll die Funktionsweise der Einstellungen Zeitpunkt und Zeitspanne verdeutlicht werden.

Schlüsselwort Wert Beschreibung
Zeitpunkt 00:00:00 Der Startzeitpunkt des Reports.
Zeitspanne 1 Tag Die Zeitspanne, die ein erzeugter Report aus dieser Vorlage ab dem Startzeitpunkt rückblickend umfasst.

Die Einstellung Zeitpunkt legt den Startzeitpunkt des Reports fest. In unserem Beispiel beginnt ein erzeugter Report aus dieser Vorlage um 00:00:00 Uhr.

Die Einstellung Zeitspanne bestimmt, wie weit zurück ein erzeugter Report aus dieser Vorlage Daten sammelt. In diesem Fall sammelt ein erzeugter Report aus dieser Vorlage Daten für einen Zeitraum von einem Tag.

Basierend auf diesen Einstellungen wird ein erzeugter Report aus dieser Vorlage am 13.01.2023 um 00:00:00 Uhr generiert und umfasst den Zeitraum vom 12.01.2023 um 00:00:00 Uhr bis zum 13.01.2023 um 00:00:00 Uhr.

Aufbewahrung

Die Einstellung Aufbewahrung legt fest wie lange einzelne Reports aufbewahrt werden. Nach Ablauf der eingestellten Zeitspanne der Aufbewahrung kann ein erzeugter Report aus dieser Vorlage nicht erneut angefordert werden und alle Downloadlinks verlieren ihre Gültigkeit.

Report-Variablen

Unter dem Reiter Variablen in den Konfigurationseinstellungen des Reports kann der Benutzer Layout-Variablen für die Report-Erstellung festlegen, panelspezifische Variablen überschreiben oder eigene Variablen hinzufügen.
Eine Liste der zur Verfügung stehenden Report-Variablen finden Sie hier.

Erstellen und Überschreiben von Report-Variablen

Nach Auswahl der Option "Bearbeiten" können Sie durch Klicken auf "Neue Variable hinzufügen" spezifische Report-Variablen definieren. Es gibt zwei Arten von Variablen, die Sie erstellen können:

Variablentyp Beschreibung
Layout-Variablen Variablen dieses Typs gelten ausschließlich für die m2v-App.
Parameters (Panelspezifische Variablen) Variablen dieses Typs überschreiben automatisch gleichnamige Variablen im Grafana-Dashboard.

In den Report-Einstellungen können Sie grundsätzlich alle in Grafana definierten Variablen unabhängig von ihrem Typ überschreiben. Dies ermöglicht beispielsweise die Anpassung des Aggregationszeitraums, der Aggregationsfunktion oder anderer für verschiedene Zwecke verwendeter Variablen, ohne dass ein neues Dashboard erstellt werden muss.

Bitte beachten Sie, dass diese Überschreibungen nur für die Erstellung des jeweiligen Reports gelten und keine Auswirkungen auf die Darstellung des Dashboards oder anderer Reports haben, die auf dem Dashboard basieren.

Beispiel

Angenommen, Sie möchten die Aggregationsfunktion auf Durchschnitt ändern und die Daten über einen Zeitraum von fünf Minuten gruppieren. In diesem Fall müssten Sie zwei neue Variablen hinzufügen und für beide den Typ Parameter auswählen.

Der Name der Variablen bestimmt die zu überschreibende Grafana-Variable, in diesem Fall also aggrFunction und selectedInterval. Der Wert von aggrFunction wird auf mean festgelegt und der Wert von selectedInterval auf 5m.

Variabelkonfiguration:

Typ Variabel Wert
Parameters aggrFunction mean
Parameters selectedInterval 5m

Nachdem Sie auf "Speichern" geklickt haben, kann der neue Report generiert werden. Sie können das Ergebnis hier einsehen.

Priorisierung von Report-Variablen

Hinweis

Aus technischen Gründen muss für eine überschriebene Variable ein neues temporäres Dashboard angelegt werden. Dieses Dashboard wird nach erfolgreicher Report-Generierung wieder gelöscht.

Report-Variablen werden bei der Report-Erstellung stets wie folgt priorisiert:

Priorität Quelle Beschreibung
1 Report-Einstellungen Variablen, die hier festgelegt werden, haben die höchste Priorität.
2 Grafana Variablen, die in Grafana festgelegt wurden, haben die zweithöchste Priorität.
3 Standardwerte Wenn keine Variablen in den Report-Einstellungen oder in Grafana festgelegt wurden, werden die Standardwerte verwendet.

Das bedeutet, dass die in den Report-Einstellungen definierten Variablen eine höhere Priorität haben als die in Grafana festgelegten Variablen und die Standardwerte.

Aufgabenplanung

Hier kann der Benutzer planen zu welchem Zeitpunkt ein erzeugter Report aus dieser Vorlage erstellt werden soll.

Reports werden standardmäßig jeden Tag um 00:00 Uhr (12:00 AM) generiert. Die Einstellung Disabled im Dropdown-Menü deaktiviert das automatische Erstellen des Reports.

Beispiel

Die Konfiguration für einen Report, der nur jeden Montag (wöchentlich) um 00:00 Uhr (12:00 AM) generiert wird, sieht wie folgt aus:

Cron-Syntax

Die Cron-Syntax wird zur Definition von Zeitplänen für die wiederholte Erstellung von Reports verwendet. Eine typische Cron-Zeitangabe besteht aus fünf Feldern, die durch Leerzeichen getrennt sind.

Feld Beschreibung Mögliche Werte
Minuten Gibt an, zu welcher Minute der Befehl ausgeführt werden soll. 0-59
Stunden Gibt an, zu welcher Stunde der Befehl ausgeführt werden soll. 0-23
Tag-des-Monats Gibt an, an welchem Tag des Monats der Befehl ausgeführt werden soll. 1-31
Monat Gibt an, in welchem Monat der Befehl ausgeführt werden soll. 1-12 oder Jan, Feb, Mar, etc.
Wochentag Gibt an, an welchem Wochentag der Befehl ausgeführt werden soll. 0-7 (0 und 7 stehen für Sonntag) oder Sun, Mon, Tue, etc.

Unsere Implementierung verwendet zusätzlich eine sechste Stelle am Anfang für die Sekunden.

Die Felder können auf verschiedene Weisen definiert werden:

  • Eine einzelne Zahl: Der Befehl wird nur zu dieser bestimmten Zeit ausgeführt.
  • Mehrere Zahlen, getrennt durch Kommas: Der Befehl wird zu den angegebenen Zeiten ausgeführt.
  • Ein Bereich von Zahlen, getrennt durch einen Bindestrich: Der Befehl wird zu allen Zeiten innerhalb dieses Bereichs ausgeführt.
  • Der Stern (*) als Platzhalter: Er steht für jede mögliche Zahl und bedeutet, dass der Befehl zu jeder Minute/Stunde/Tag/Monat/Wochentag ausgeführt wird.
Beispiel

m2v-Cron-Syntax:

Sekunden Minuten Stunden Tag-des-Monats Monat Wochentag

Angenommen, Sie möchten einen Report jeden Tag um 6 Uhr morgens erstellen. Die Cron-Zeitangabe dafür wäre

0 0 6 * * *.

  • 0 steht für die Sekunde, in der der Befehl ausgeführt werden soll (am Anfang jeder Minute).
  • 0 steht für die Minute, in der der Befehl ausgeführt werden soll
  • 6 steht für die Stunde, in der der Befehl ausgeführt werden soll (6 Uhr morgens).
  • Das erste * steht für den Tag des Monats und bedeutet, dass der Befehl an jedem Tag des Monats ausgeführt wird.
  • Das zweite * steht für den Monat und bedeutet, dass der Befehl in jedem Monat ausgeführt wird.
  • Das dritte * steht für den Wochentag und bedeutet, dass der Befehl an jedem Wochentag ausgeführt wird.

Insgesamt bedeutet diese Cron-Zeitangabe also, dass der Befehl jeden Tag um 6 Uhr morgens ausgeführt wird.

Für eine visuelle Unterstützung bei der Erstellung von Cron-Zeitangaben können Sie Crontab Guru verwenden. Bitte beachten Sie, dass Crontab Guru keine Sekunden unterstützt.

Archivieren

Mit einem Klick auf können Sie den ausgewählten Report archivieren. Bitte beachten Sie, dass Sie diese Aktion vorher bestätigen müssen.