Use monitoring and maintenance endpoints of a service running in your yuuvis® Momentum cluster.
Introduction
As of 2023 Spring, the API gateway offers endpoints to retrieve and manage metrics. E.g., it is possible to dynamically calculate the binary storage used by individual tenants. This information could be useful, e.g., for billing purposes.
The following endpoints are available. The URLs contain the metric path parameter to specify the type of metric. As of 2023 Spring, only the value storage is accepted.
| Retrieval | Reset | |
|---|---|---|
| metric for all tenants | GET /api/system/metrics/{metric} | DELETE /api/system/metrics/{metric} |
| metric for any specified tenant | GET /api/system/tenants/{tenant}/metrics/{metric} | DELETE /api/system/tenants/{tenant}/metrics/{metric} |
| metric for currently active tenant | GET /api/admin/metrics/{metric} | DELETE /api/admin/metrics/{metric} |
Storage Metric
The storage metric allows to dynamically calculate the binary storage used by individual tenants, e.g., for billing purposes.
In the endpoint URLs above, use storage as value for the metric path parameter. E.g.:
https://<host>/api/system/metrics/storage
The number is calculated from the content stream length stored in the database. The number includes all binary content files assigned to a DMS object or an old version of a DMS object. Invisible objects (flagged with OBJECT_FLAGGED_FOR _DELETION in the search index) are included as well. Binary content files that are referenced by multiple DMS objects (e.g., compound documents) are counted only once. Rendition files are also NOT included.
The initial calculation or triggered recalculation is a counting process via database statements over all tenants. It is managed by the AUDIT Service and its behavior (automation and fail safety) can be adjusted in the AUDIT service's configuration. During the counting process in the database, no storage metric can be retrieved. Requests to the GET endpoints listed above return an error.
After the successful counting process in the database, the result is stored in Redis and dynamically updated during any operations on binary content files via API gateway.