AUDIT Service
- Technische Redaktion
This core service manages the audit trail of individual DMS objects. Find here characteristics and configuration options.
Table of Contents
Characteristics
| Service Name | audit |
|---|---|
| Port Range | 7251 |
| Profiles | prod,jpapostgres,dbs,docker,kubernetes,metrics,redis |
| Helm Chart | yuuvis |
Function
The AUDIT service is responsible for the management of the individual objects' audit trails. Those entries are stored in a separate database table.
>> Database Schema
Each action that is applied to an object triggers the creation of a new entry in the object's audit trail. As of 2022 Winter, this behavior can be adjusted by configuration (see below).
>> Audit Trail - an "Object's History"
In order to allow the creation of custom audit entries by a custom service that is running inside the yuuvis® Momentum cluster, the following internal endpoint can be used.
>> POST /audit/api/dms/objects/custom
If an object is deleted, all audit entries are deleted as well.
Configuration
The yuuvis® Momentum configuration files for the operation in the Kubernetes cluster are stored on the Git Server configured in the system. In order to change the configuration of a service, you need to access the Git repository.
Service-specific Parameters
| Parameter | Type | Default Value | Description |
|---|---|---|---|
| Integer | -1 | Controls the automated recalculation of the storage metric. If the value is -1, there is no automated recalculation. It has to be triggered via the DELETE /api/system/metrics/{metric} endpoint. If any value > 0 is configured, it is considered as time in seconds between two automated recalculation processes. As soon as the specified time is passed after the previous recalculation process, a new recalculation process is triggered. High Database Workload We do not recommend to activate the automated recalculation as no storage metric can be retrieved during the processing time. |
| Integer | 3600 | Controls the behavior of the storage metric recalculation processing in fail situations like, e.g., an unavailable service. The configured value is considered as maximum time in seconds that the process waits for progress in the database. The database reports a progress after the recalculation for one tenant is done. If the database does not report ongoing progress for a time period that exceeds the configured value, the recalculation is restarted. |
Parameters in Profile-related Configuration Files
The following parameters are referenced from the corresponding profiles. Click a profile in order to display descriptions and default values of the corresponding parameters.
| Configuration File | Parameters |
|---|---|
application-dbs.yml | storage |
The values for the parameters can be modified as described here.
>> Configuring Services using Profiles.
Parameters in Service Configuration File
The audit section in the serviceConfiguration.json file can be used to skip the creation of audit entries for specific actions or for all actions.