Metrics

10. Metrics#

Nubus components expose metrics, so you can monitor your domain and diagnose problems.

Warning

The metrics endpoint and its data model are experimental.

Metric names, labels, and their meaning may change in future versions. Univention doesn’t guarantee backward compatibility.

10.1. Metrics endpoint#

The UDM HTTP REST API provides a metrics endpoint at /univention/udm/-/metrics. This endpoint is compatible with Prometheus and exposes metrics for monitoring and integrating with observability tools.

The endpoint requires authentication. To access the endpoint, you must be a member of the group udm-rest-metrics with the DN cn=udm-rest-metrics,cn=groups,ldap/base-dn, or a member of any group with access to the UDM HTTP REST API. For information about authorization groups in UDM HTTP REST, see Authorization groups in Nubus - Customization and Modification Manual [5].

Added in version 5.2-5-errata-410: Nubus creates the group udm-rest-metrics automatically during UDM HTTP REST API setup. See UCS 5.2 erratum 410.

10.2. Available metrics#

The endpoint returns data in the Prometheus exposition format.

Total number of managed, non-deactivated users

This metric counts managed, non-deactivated user objects.

Listing 10.1 Total number of managed, non-deactivated users#
# 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>
License limit for active users

If your Nubus domain doesn’t have a license, this metric may return -1 or +Inf.

Listing 10.2 License limit for active users#
# 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

Depending on your deployment type, you receive the following version information.

Listing 10.3 UCS version information#
# 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
Listing 10.4 Nubus for Kubernetes version information#
# 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. Available labels#

domain

The domain name. All metrics include the domain label, which you can use to group and filter metrics.

license_uuid

A stable identifier derived from the license keyId if available, otherwise from the license object’s UUID. It provides a globally unique identifier for the deployment.

platform

Each metric, except the version metric, include a platform indicator that identifies the deployment type. The value is either ucs or k8s.

On this page