Broadleaf Microservices
  • v1.0.0-latest-prod

Advanced Audit (Since 2.1.4-GA, 2.2.0-GA)

Table of Contents
Important
This feature is still in Beta. Functionality and documentation are subject to change. Audit events will be more deeply integrated into the framework in future releases, but the functionality is available for review now - allowing the creation of custom audit events.

Audit Services (aka Advanced Audit) manages and stores audit events from across the system. This includes key domain mutations, as well as key application lifecycle events that benefit from a forensic history store.

In general, there are three types of audit events created and stored in the system:

  1. Audit event without detail. This is an event that only contains header information regarding time, description, user, etc…​ This type of event is useful for simple application lifecycle demarcation without requiring extensive informational details.

  2. Audit event with raw detail. This is similar to the event without detail, but includes a collection of detailed information that is unstructured and may be represented in whatever format the caller desires.

  3. Audit event with structured field detail. This is similar to the event with raw detail, but the detail objects adhere to a structured format of before/after field values for a specific entity mutation.

Reference

See AuditServices documentation for reference and usage information.