Skip to content

Commit 6db11d8

Browse files
committed
ITC-3510 Status Page Groups
1 parent 1fe4e13 commit 6db11d8

File tree

8 files changed

+208
-3
lines changed

8 files changed

+208
-3
lines changed
43.9 KB
Loading
43.9 KB
Loading
3.2 KB
Loading
52.2 KB
Loading
1.65 KB
Loading
58.1 KB
Loading

de/docs/reporting/reporting.md

Lines changed: 102 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,13 @@ Jedes Element einer Statusseite kann Informationen über die enthaltenden Proble
151151
In- und externe Ansicht sind prinzipiell gleich.aber in der internen Ansicht sind die Elementnamen verlinkt.
152152

153153
### Status, Statusfarbe
154-
Die farbliche kennzeichnung der Elemente entspricht den oitc Statusfarben. Die Farbe (Status) wird abhängig vom Typ des Elements ermittelt.
154+
Die farbliche kennzeichnung der Elemente entspricht den openITCOCKPIT Statusfarben. Die Farbe (Status) wird abhängig vom Typ des Elements ermittelt.
155+
156+
- **Lila:** Nicht im Monitoring
157+
- **Grün:** Betrieb
158+
- **Gelb:** Leistungsprobleme
159+
- **Rot:** Schwerwiegender Ausfall
160+
- **Grau:** Unbekannt
155161

156162
| Typ | Status/Farbe |
157163
| ---------------- | ----------------------------------------------------------------------------------------------- |
@@ -174,6 +180,101 @@ Es wird über alles gezählt, was auch zur Ermittlung des Status herangezogen wi
174180
| Hostgruppe | Es werden alle Probleme über alle Hosts und alle in den Hosts enthaltenen Services gezählt(angezeigt). Es werden alle Downtimes (laufend, geplant) über alle Hosts und die enthaltenen Services gezählt(angezeigt). |
175181

176182

183+
## Statusseiten-Gruppen
184+
185+
Das _Statusseiten-Gruppen_-Feature ermöglicht es Ihnen, mehrere Statusseiten in einer zweidimensionalen Matrix zu organisieren und so eine übersichtliche und hoch aggregierte Darstellung zu erhalten.
186+
Jede Statusseiten-Gruppe besteht aus mehreren `Sammlungen` und `Kategorien`.
187+
188+
Angenommen, Sie möchten den Status verschiedener Rechenzentren in einer Statusseiten-Gruppe präsentieren. Zunächst sollten Sie für jedes Rechenzentrum eine eigene Statusseite erstellen.
189+
190+
Im nächsten Schritt können Sie Sammlungen wie `Fulda`, `Frankfurt` und `Berlin` definieren, um die Standorte der Rechenzentren darzustellen.
191+
Anschließend fügen Sie Kategorien wie `Facility`, `Infrastructure` und `Services` hinzu. Jede Zelle in der Matrix kann eine oder mehrere Statusseiten enthalten und bietet Ihnen so einen umfassenden Überblick über den Status jedes Standorts und jeder Kategorie.
192+
193+
Das Beispiel würde zu einer Statusseiten-Gruppen-Matrix wie dieser führen:
194+
195+
| | Facility | Infrastructure | Services |
196+
|------------|-----------------|------------------|-----------------|
197+
| Fulda | [Statusseite/n] | [Statusseite/n] | [Statusseite/n] |
198+
| Frankfurt | [Statusseite/n] | [Statusseite/n] | [Statusseite/n] |
199+
| Berlin | [Statusseite/n] | [Statusseite/n] | [Statusseite/n] |
200+
201+
202+
Optional können Sie der Statusseiten-Gruppe einen Freitext hinzufügen. So können Sie nützliche Informationen wie Telefonnummern, Links zu einem Wiki oder andere relevante Details hinterlegen.
203+
204+
### Erstellung
205+
206+
Die Erstellung neuer Statusseiten-Gruppen erfolgt in zwei Schritten. Im ersten Schritt definieren Sie die Statusseiten-Matrix.
207+
208+
![](/images/status-page-groups/create-status-page-group-step1.png)
209+
210+
| Feld | Erforderlich | Beschreibung |
211+
|-----------------------------------|---------------------------|-----------------------------------------------------------------------------------------------------|
212+
| Container | :fontawesome-solid-xmark: | Der Container bestimmt die Auswahl der Elemente, Elemente des Root-Containers sind immer auswählbar |
213+
| Name | :fontawesome-solid-xmark: | Der Name der Statusseiten-Gruppe |
214+
| Beschreibung | | Optionale Beschreibung |
215+
| Weitere Informationen | | Optionales Freitextfeld für relevante Informationen wie Telefonnummern |
216+
| Zeige Alarme als Ticker-Nachricht | | Legt fest, ob Alarme als Lauftext angezeigt werden |
217+
| Sammlung | | Erste Dimension der Matrix (Y-Achse) |
218+
| Kategorie | | Zweite Dimension der Matrix (X-Achse) |
219+
220+
221+
Im zweiten Schritt können Sie Statusseiten zuweisen.
222+
Jede Zelle kann mehrere Statusseiten enthalten oder auch leer bleiben.
223+
224+
openITCOCKPIT berechnet den Status jeder Zelle in einer Statusseiten-Gruppe, indem alle zugewiesenen Statusseiten ausgewertet werden und der schlechteste Status übernommen wird – dies ist als „Worst State Wins“-Prinzip bekannt.
225+
226+
- **Zellenstatus:** Jede Zelle kann mehrere Statusseiten enthalten. Der Status der Zelle entspricht dem schlechtesten Status aller zugewiesenen Statusseiten.
227+
- **Sammlungsstatus (Zeile):** Der Status einer Sammlung (Zeile) wird durch die Kumulation der Status aller Zellen in dieser Zeile berechnet. Auch hier bestimmt der schlechteste Status den Gesamtstatus der Sammlung.
228+
- **Kategorie-Status (Spalte):** Der Status einer Kategorie (Spalte) wird durch die Kumulation der Status aller Zellen in dieser Spalte berechnet. Der schlechteste Status in der Spalte wird als Kategorie-Status angezeigt.
229+
230+
Dieses Vorgehen stellt sicher, dass kritische Probleme innerhalb einer Gruppe sofort auf Sammlungs- oder Kategorie-Ebene sichtbar sind und Sie schnell reagieren können.
231+
232+
![](/images/status-page-groups/create-status-page-group-step2.png)
233+
234+
### Ansicht
235+
236+
Die Ansicht einer Statusseiten-Gruppe beginnt mit dem Namen der Gruppe, gefolgt von einer optionalen Beschreibung.
237+
238+
Oben wird ein großes Icon angezeigt, das den Gesamtstatus der Statusseiten-Gruppe visuell darstellt. Der Status wird durch die Kumulation aller zugewiesenen Statusseiten nach dem „Worst State Wins“-Prinzip berechnet.
239+
240+
#### Verfügbare Zustände
241+
242+
- **Lila:** Nicht im Monitoring
243+
- **Grün:** Betrieb
244+
- **Gelb:** Leistungsprobleme
245+
- **Rot:** Schwerwiegender Ausfall
246+
- **Grau:** Unbekannt
247+
248+
Neben dem Icon wird ein Zähler angezeigt, der die Gesamtanzahl der Hosts und Services darstellt, die von der Statusseiten-Gruppe repräsentiert werden.
249+
250+
Darunter kann ein optionales Freitextfeld angezeigt werden, das für nützliche Informationen wie Telefonnummern, E-Mail-Adressen oder andere Details genutzt werden kann.
251+
252+
Alle aktuellen Probleme werden als Lauftext (Marquee) angezeigt, sodass kritische Probleme sofort sichtbar sind.
253+
254+
#### Statusübersicht
255+
256+
Der Bereich „Statusübersicht“ zeigt die zweidimensionale Matrix aller Sammlungen (Zeilen) und Kategorien (Spalten). Jede Zelle zeigt den Status der zugewiesenen Statusseiten und ermöglicht einen schnellen Überblick über Ihre Infrastruktur.
257+
258+
#### Problemtabelle
259+
260+
Unterhalb der Matrix wird eine Tabelle angezeigt, die alle Probleme (sofern vorhanden) detailliert auflistet, damit Sie diese schnell identifizieren und beheben können.
261+
262+
![](/images/status-page-groups/status_page_group_view.png)
263+
264+
#### Dashboard
265+
266+
Statusseiten-Gruppen können auch zum Dashboard eines Benutzers hinzugefügt werden, um schnellen Zugriff und Monitoring zu ermöglichen.
267+
268+
![](/images/status-page-groups/status_page_group_widget.png)
269+
270+
Das Widget zeigt die gleichen Informationen wie die Standardansicht der Statusseiten-Gruppen, einschließlich Gesamtstatus, Host- und Service-Zähler, benutzerdefinierte Informationen und die Statusübersicht-Matrix.
271+
![](/images/status-page-groups/statuspage_group_as_dashboard.png)
272+
273+
Sie können ein automatisches Aktualisierungsintervall für das Widget konfigurieren, damit die angezeigten Daten immer aktuell sind.
274+
275+
![](/images/status-page-groups/status_page_group_refresh.png)
276+
277+
177278
## Autoreports <span class="badge badge-primary badge-outlined" title="Community Edition">CE</span>
178279

179280
Das Autoreport-Modul in openITCOCKPIT ist ein konfigurierbarer Report, der automatisiert versendet werden kann. Ein

en/docs/reporting/reporting.md

Lines changed: 106 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Status page elements can have additional informations about acknowledgements, do
108108

109109
| Field | Required | Description |
110110
|----------------------------------------------|---------------------------|-----------------------------------------------------------------------------------------------------------|
111-
| Container | :fontawesome-solid-xmark: | The container determines the element selection,elements of the root container aere always selectable |
111+
| Container | :fontawesome-solid-xmark: | The container determines the element selection,elements of the root container are always selectable |
112112
| Name | :fontawesome-solid-xmark: | The name of the page |
113113
| Description | | Optional page description |
114114
| Public | | if marked the page is public - without autentication accessible |
@@ -133,7 +133,16 @@ Status page elements can have additional informations about acknowledgements, do
133133
In- / external View are generally the same, but in internal view the element names are links to the elements.
134134

135135
### State, Color
136-
the color of the elements are the general oitc state colors. The color will be calculated dependend of the element type.
136+
the color of the elements are the general openITCOCKPIT state colors. The color will be calculated dependend of the element type.
137+
138+
#### Available states
139+
140+
- **Purple:** Not in Monitoring
141+
- **Green:** Operational
142+
- **Yellow:** Performance Issues
143+
- **Red:** Major Outage
144+
- **Gray:** Unknown
145+
137146

138147
| Type | State/Color | |
139148
|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
@@ -156,6 +165,101 @@ The counting of problems/downtimes correspndents to the calculating of the state
156165
| Host group | all problems/acknowledgemnts over all hosts and included services will be counted. All downtimes(current, planned) of all hosts and included services will be counted and displayed |
157166

158167

168+
## Status page groups
169+
170+
The _Status Page Groups_ feature allows you to organize multiple status pages into a 2-dimensional matrix, providing a clear and high-level overview.
171+
Each Status Page Group consists of multiple `Collections` and `Categories`.
172+
173+
Let's assume you want to present the status of different data centers in a status page group. First of all you should create status pages for each data center.
174+
175+
In the next step you can define collections such as `Fulda`, `Frankfurt` and `Berlin` to represent data center locations.
176+
Next, you add categories like `Facility`, `Infrastructure` and `Services`. Each cell in the matrix can contain one or more status pages, giving you a comprehensive view
177+
of the status for each location and category.
178+
179+
The given example would result in a Status Page Group matrix like this
180+
181+
| | Facility | Infrastructure | Services |
182+
|------------|-----------------|------------------|-----------------|
183+
| Fulda | [Status Page/s] | [Status Page/s] | [Status Page/s] |
184+
| Frankfurt | [Status Page/s] | [Status Page/s] | [Status Page/s] |
185+
| Berlin | [Status Page/s] | [Status Page/s] | [Status Page/s] |
186+
187+
188+
Optionally, you can add custom text to the Status Page Group. This allows you to include useful information such as phone numbers, links to a wiki, or other relevant details.
189+
190+
### Creating
191+
192+
The creation of new Status Page Groups is separated into two steps. In the first step, you need to define the status page matrix.
193+
194+
![](/images/status-page-groups/create-status-page-group-step1.png)
195+
196+
| Field | Required | Description |
197+
|----------------------------------------------|---------------------------|-----------------------------------------------------------------------------------------------------------|
198+
| Container | :fontawesome-solid-xmark: | The container determines the element selection,elements of the root container aere always selectable |
199+
| Name | :fontawesome-solid-xmark: | The name of the Status Page Group |
200+
| Description | | Optional description |
201+
| Additional information | | Optional free text field to store relevant information such as phone numbers. |
202+
| Show alerts as Ticker message | | Determins if alerts will be displayed as scrolling text (marquee) |
203+
| Collection | | First dimension of the matrix (Y axis) |
204+
| Category | | Second dimension of the matrix (X axis) |
205+
206+
207+
In the second step, you can assign status pages.
208+
Each cell can contain multiple status pages, or no status page.
209+
210+
openITCOCKPIT calculates the status of each cell in a Status Page Group by evaluating all assigned status pages and determining the worst state—this is known as the "worst state wins" principle.
211+
212+
- **Cell Status:** Each cell can contain multiple status pages. The cell's status is set to the worst state found among all its status pages.
213+
- **Collection Status (Row):** The status for a collection (row) is calculated by cumulating the states of all cells in that row. Again, the worst state determines the overall status for the collection.
214+
- **Category Status (Column):** The status for a category (column) is calculated by cumulating the states of all cells in that column. The worst state in the column will be shown as the category status.
215+
216+
This approach ensures that any critical issue within a group is immediately visible at the collection or category level, making it easy to identify and respond to problems.
217+
218+
![](/images/status-page-groups/create-status-page-group-step2.png)
219+
220+
### View
221+
222+
The view of a Status Page Group starts with the name of the group, followed by an optional description.
223+
224+
At the top, a large icon visually represents the overall state of the Status Page Group. The state is calculated by cumulating the states of all assigned status pages—using the "worst state wins" principle.
225+
226+
#### Available states
227+
228+
- **Purple:** Not in Monitoring
229+
- **Green:** Operational
230+
- **Yellow:** Performance Issues
231+
- **Red:** Major Outage
232+
- **Gray:** Unknown
233+
234+
Next to the icon, you will see a counter displaying the total number of hosts and services represented by the Status Page Group.
235+
236+
Below this, an optional free text field can be shown. This area can be used to display useful information such as phone numbers, email addresses, or other relevant details.
237+
238+
All current problems are listed as scrolling marquee text, making critical issues immediately visible.
239+
240+
#### Status Overview
241+
242+
The "Status Overview" section displays the 2-dimensional matrix of all collections (rows) and categories (columns). Each cell shows the status of the assigned status pages, making it easy to get a high-level overview of your infrastructure.
243+
244+
#### Problems Table
245+
246+
Below the matrix, a table lists all problems (if any) in detail, so you can quickly identify and address issues.
247+
248+
![](/images/status-page-groups/status_page_group_view.png)
249+
250+
#### Dashboard
251+
252+
Status Page Groups can also be added to a user's Dashboard for quick access and monitoring.
253+
254+
![](/images/status-page-groups/status_page_group_widget.png)
255+
256+
The widget displays the same information as the default view of Status Page Groups, including the overall state, host and service counters, custom information, and the status overview matrix.
257+
![](/images/status-page-groups/statuspage_group_as_dashboard.png)
258+
259+
You can configure an auto-refresh interval for the widget to ensure the displayed data is always up to date.
260+
261+
262+
![](/images/status-page-groups/status_page_group_refresh.png)
159263

160264
## Autoreports <span class="badge badge-primary badge-outlined" title="Community Edition">CE</span>
161265

0 commit comments

Comments
 (0)