MailStore-(Server & SPE)-Check-Referenz

Konfigurationsfelder, Warnschwellen und unterstützte Plattformen für den MailStore-(Server & SPE)-Check in octoja.

MailStore-(Server & SPE)-Check-Referenz

Konfigurationsoptionen und Warnverhalten für den MailStore-(Server & SPE)-Check.

Der MailStore-(Server & SPE)-Check meldet die Anzahl archivierter Benutzer, wertet die Archivierungsprofil-Läufe aus und überwacht den Ablauf von TLS-Zertifikaten — die beiden letzten sind standardmäßig aktiviert. Das Feld Edition bestimmt das Produkt. MailStore SPE (Management-API) fragt die Management-API der Service-Provider-Edition (SPE) ab und meldet eine Zahl je Instanz sowie eine deployment-weite Gesamtzahl. MailStore Server (Administrations-API) fragt einen einzelnen MailStore Server ab, der keine Instanzen kennt, und meldet eine einzige Zahl. Der Check läuft alle 6 Stunden auf dem octoja-Agenten auf einem Windows-Host, der die MailStore-API erreichen kann.

Konfigurationsfelder

Feld	Typ	Erforderlich	Standard	Beschreibung
Edition	select	Ja	MailStore SPE (Management-API)	Welches MailStore-Produkt überwacht wird: MailStore SPE (Management-API) oder MailStore Server (Administrations-API). Checks, die vor diesem Feld angelegt wurden, bleiben auf der Service-Provider-Edition, bis du es änderst
Server	string	Nein	localhost	Hostname oder IP des MailStore-Servers
Port	number	Nein	8474	Port der SPE-Management-API. Nur sichtbar, wenn Edition auf MailStore SPE steht
Port	number	Nein	8463	Port der MailStore-Server-Administrations-API. Nur sichtbar, wenn Edition auf MailStore Server steht
Benutzername	string	Ja	—	Management-API-Benutzer (SPE) oder MailStore-Administrator (Server)
Passwort	password	Ja	—	Passwort des API-Benutzers
SSL-Zertifikatsfehler ignorieren	boolean	Nein	true	Wenn aktiviert, werden selbstsignierte Zertifikate akzeptiert (typisch für MailStore-Installationen). Nur deaktivieren, wenn ein CA-signiertes Zertifikat auf dem MailStore-Host installiert ist
Archivierungsprofil-Läufe prüfen	boolean	Nein	true	Den letzten Lauf jedes Archivierungs- bzw. Export-Profils auswerten (`GetWorkerResults`). In SPE wird jede laufende Instanz ausgewertet
Rückblick-Zeitfenster (Stunden)	number	Nein	24	Wie weit zurück nach Profil-Ausführungen gesucht wird. Nur sichtbar, wenn Archivierungsprofil-Läufe prüfen aktiviert ist
Bei Läufen mit Warnungen warnen	boolean	Nein	true	Einen letzten Lauf mit `completedWithWarnings` als Warnung statt als Erfolg werten. Nur sichtbar, wenn Archivierungsprofil-Läufe prüfen aktiviert ist
Zertifikatsablauf überwachen	boolean	Nein	true	Das Zertifikat des API-Endpunkts sowie aller zusätzlichen Endpunkte prüfen
Warnschwelle (Tage)	number	Nein	30	Warnen, wenn ein Zertifikat innerhalb dieser Anzahl Tage abläuft. Nur sichtbar, wenn Zertifikatsablauf überwachen aktiviert ist
Kritisch-Schwelle (Tage)	number	Nein	14	Kritisch, wenn ein Zertifikat innerhalb dieser Anzahl Tage abläuft. Nur sichtbar, wenn Zertifikatsablauf überwachen aktiviert ist
Zusätzliche Endpunkte	array	Nein	leer	Weitere TLS-Endpunkte, die als `host` oder `host:port` geprüft werden (z. B. die Client-Access-URL). Der API-Endpunkt wird immer geprüft. Nur sichtbar, wenn Zertifikatsablauf überwachen aktiviert ist

Warnverhalten

Das Gesamtergebnis des Checks ist der schlechteste Status über die Benutzerzahlen, die Archivierungsprofile und die überwachten Zertifikate hinweg.

Bedingung	Schweregrad
Benutzername oder Passwort fehlt in der Check-Konfiguration	Fehler
SPE: `GetInstances`-API-Aufruf fehlgeschlagen (Netzwerkfehler, Authentifizierungsfehler, Zertifikatsfehler)	Fehler
MailStore Server: Abfrage der Benutzerzahl fehlgeschlagen (Netzwerkfehler, Authentifizierungsfehler, Zertifikatsfehler)	Fehler
SPE: Keine Instanzen zurückgegeben	Warnung
Mindestens eine Instanz hat eine unbestimmbare Benutzerzahl	Warnung
Der letzte Lauf eines Archivierungsprofils ist `failed`, `completedWithErrors`, `cancelled`, `disconnected` oder `threadAbort`	Kritisch
Der letzte Lauf eines Archivierungsprofils ist `completedWithWarnings`	Warnung (OK, wenn Bei Läufen mit Warnungen warnen deaktiviert ist)
Der letzte Lauf eines Archivierungsprofils meldet einen beliebigen anderen Status	Warnung
Ein überwachtes Zertifikat läuft innerhalb der Kritisch-Schwelle ab (Standard 14 Tage) oder ist bereits abgelaufen	Kritisch
Ein überwachtes Zertifikat läuft innerhalb der Warnschwelle ab (Standard 30 Tage)	Warnung
Ein zusätzlicher Endpunkt war nicht erreichbar oder hat kein Zertifikat vorgelegt	Warnung
Eine Benutzerzahl konnte ermittelt werden — in SPE für jede Instanz (laufend über `GetUsers`, gestoppt über den Lizenz-Fallback) —, jedes Archivierungsprofil ist in Ordnung und kein Zertifikat läuft demnächst ab	OK

Erfasste Metriken

Je Check-Lauf:

totalUsers — Summe von userCount über alle Instanzen
instanceCount — Anzahl der von GetInstances zurückgegebenen Instanzen; in der MailStore-Server-Edition immer 1
profilesChecked — Archivierungsprofile, deren letzter Lauf über alle Instanzen hinweg ausgewertet wurde
profilesFailed — davon die Anzahl mit kritischem letztem Lauf

Je Instanz:

instanceId — SPE-Instanz-Identifikator; in der MailStore-Server-Edition leer
name — Anzeigename der Instanz (fällt auf Alias und dann auf ID zurück); in der MailStore-Server-Edition der konfigurierte Server-Host
status — Lebenszyklus-Status der Instanz aus SPE (z. B. Running, Stopped); in der MailStore-Server-Edition immer running
userCount — archivierte Benutzerzahl, oder null wenn unbestimmbar
source — wie die Zahl ermittelt wurde: GetUsers (laufend + API-Aufruf), License (laufend + Lizenz-Fallback), License(stopped) (gestoppt + Lizenz-Fallback), leer (unbestimmbar). Die beiden Lizenz-Werte gibt es nur in SPE

Je Archivierungsprofil — aufgeführt werden nur Profile, deren letzter Lauf nicht in Ordnung war; einwandfreie werden lediglich gezählt:

instanceName — Instanz, zu der das Profil gehört
profileName — Profilname aus GetProfiles, oder die Profil-ID, wenn der Name nicht aufgelöst werden konnte
lastStatus — roher MailStore-Statuswert des letzten Laufs
lastRunAt — Zeitstempel des letzten Laufs, oder null

Je geprüftem Zertifikats-Endpunkt:

endpoint — geprüfter host:port
notAfter — Ablaufzeitpunkt des Zertifikats, oder null wenn das Zertifikat nicht gelesen werden konnte
daysRemaining — Tage bis zum Ablauf, nach Ablauf negativ
unreachable — true, wenn der Endpunkt nicht erreichbar war oder kein Zertifikat vorgelegt hat

Plattform-Unterstützung

Plattform	Unterstützt
Windows Server	Ja
Windows Desktop	Ja
Linux	Nein
macOS	Nein

Hinweise

Der Check läuft alle 360 Minuten (6 Stunden) auf dem Agenten. Das Intervall ist nicht durch den Benutzer konfigurierbar.
HTTP-Timeout je API-Aufruf beträgt 30 Sekunden. Zusätzliche Zertifikats-Endpunkte werden mit einem Timeout von 10 Sekunden geprüft.
Der Check verwendet HTTP-Basic-Authentifizierung. Die konfigurierten Zugangsdaten werden nur für die API-Aufrufe verwendet und erscheinen nie in der Check-Ausgabe.
In SPE unterscheidet ein erfolgreicher Lauf drei Quellen je Instanz: GetUsers ist die maßgebliche Live-Zahl für laufende Instanzen; License ist die usedLicenseCount je Instanz aus dem SPE-Lizenzbericht, als Fallback bei fehlgeschlagenem GetUsers; License(stopped) ist derselbe Fallback für gestoppte Instanzen.
MailStore Server kennt keine Instanzen, daher meldet der Check eine einzige Zeile mit dem Namen des konfigurierten Servers, und die Zahl stammt immer aus GetUsers — einen Lizenz-Fallback gibt es dort nicht. Archivierungsprofil-Läufe und Zertifikatsablauf werden genauso ausgewertet wie in SPE.
Der Check erfasst keine Benutzernamen, E-Mail-Adressen oder Archivinhalte — nur Anzahlen, Namen von Archivierungsprofilen samt Status ihres letzten Laufs sowie Daten zum Zertifikatsablauf.

Siehe auch: Einen MailStore-SPE-Check konfigurieren