Metriken

10. Metriken#

Nubus Komponenten stellen Metriken bereit, damit Sie Ihre Domäne überwachen und Probleme diagnostizieren können.

Warnung

Der Metrik-Endpunkt und sein Datenmodell sind experimentell.

Namen der Metriken, Bezeichner und ihre Bedeutung können sich in zukünftigen Versionen ändern. Univention garantiert keine Abwärtskompatibilität.

10.1. Metrik-Endpunkt#

Die UDM HTTP REST API stellt einen Metrik-Endpunkt unter /univention/udm/-/metrics bereit. Dieser Endpunkt ist mit Prometheus kompatibel und stellt Metriken für die Überwachung und die Integration mit Observability Werkzeugen bereit.

Der Endpunkt erfordert Authentifizierung. Um auf den Endpunkt zugreifen zu können, müssen Sie Mitglied der Gruppe udm-rest-metrics mit dem DN cn=udm-rest-metrics,cn=groups,ldap/base-dn sein, oder Mitglied einer Gruppe, die Zugriff auf die UDM HTTP REST API hat. Informationen zu Gruppen für die Autorisierung in UDM HTTP REST finden Sie unter Authorization groups in Nubus - Customization and Modification Manual [5].

Added in version 5.2-5-errata-410: Nubus erstellt die Gruppe udm-rest-metrics während der Einrichtung der UDM HTTP REST API automatisch. Siehe UCS 5.2 erratum 410.

10.2. Verfügbare Metriken#

Der Endpunkt gibt Daten im Prometheus Ausgabeformat zurück.

Gesamtanzahl der verwalteten, nicht deaktivierten Benutzer

Diese Metrik zählt verwaltete, nicht deaktivierte Benutzerobjekte.

Quellcode 10.1 Gesamtanzahl der verwalteten, nicht deaktivierten Benutzer#
# HELP nubus_users_user_total Total number of UDM objects of type users/user
# TYPE nubus_users_user_total gauge
nubus_users_user_total{license_uuid="<uuid>",domain="<domain>",platform="<platform>"} <count>
Lizenzlimit für aktive Benutzer

Wenn Ihre Nubus Domäne keine Lizenz hat, kann diese Metrik -1 oder +Inf zurückgeben.

Quellcode 10.2 Lizenzlimit für aktive Benutzer#
# HELP nubus_settings_license_users_limit_total Number of active users permitted by the installed license
# TYPE nubus_settings_license_users_limit_total gauge
nubus_settings_license_users_limit_total{license_uuid="<uuid>",domain="<domain>",platform="<platform>"} <limit>
Version

Je nach Deployment erhalten Sie die folgenden Versionsinformationen.

Quellcode 10.3 UCS Versionsinformationen#
# HELP nubus_ucs_version_info UCS version information
# TYPE nubus_ucs_version_info gauge
nubus_ucs_version_info{
  license_uuid="<uuid>",
  domain="<domain>",
  ucs="<major>.<minor>",
  patch="<patch>",
  errata="<errata>",
  system_uuid="<uuid>"
} 1
Quellcode 10.4 Nubus für Kubernetes Versionsinformationen#
# HELP nubus_n4k_version_info Nubus for Kubernetes version information
# TYPE nubus_n4k_version_info gauge
nubus_n4k_version_info{
  license_uuid="<uuid>",
  domain="<domain>",
  major="<major>",
  minor="<minor>",
  patch="<patch>"
} 1

10.3. Verfügbare Bezeichner#

domain

Der Domänenname. Alle Metriken enthalten den Bezeichner domain, mit dem Sie Metriken gruppieren und filtern können.

license_uuid

Ein stabiler Bezeichner, der aus dem keyId der Lizenz abgeleitet wird, sofern verfügbar, andernfalls aus der UUID des Lizenzobjekts. Der Bezeichner ist global eindeutig für das Deployment.

platform

Jede Metrik, außer der Version Metrik, enthält den Bezeichner platform, der das Deployment identifiziert. Der Wert ist entweder ucs oder k8s.

Auf dieser Seite