Inventory Audit log
Summary
The technical design is aimed to address the need of catalogers to track the history of changes for different entities in FOLIO. The solution uses the common approach for auditable events in FOLIO similar to the audit of events in circulation and acquisition domains.
Requirements
Functional Requirements
NFR
Arch ticket: https://folio-org.atlassian.net/browse/ARCH-306
Projected transaction volume:
Assumptions
For ECS environments: Shared entities' version history should be tracked only in the central tenant.
All changes in the system related to inventory entities (instances, items, holdings, bibs) generate Domain events.
Domain events related to update action have old and new versions of the entity
Baseline Architecture
In existing architecture, mod-inventory-storage
is responsible for persisting such entities as instances, holdings, and items. mod-entities-links
is responsible for authorities. Both modules produce domain events on create/update/delete actions from different sources.
Target Architecture
The existing architecture allows the reuse of the capabilities of the domain events approach to persist audit log events.
Audit Consumers Sequence Diagram
Solution Summary
The process is split into two main parts
1. Persistence: There are storage options that can be implemented.
Option | Description | Pros & Cons | |
---|---|---|---|
1 | RDBMS | The audit database should persist a diff of the entity. The queries are made mostly by the entity's unique identifier. Thus partitioning by UUID and subpartitioning by date ranges can be applied to audit tables | Pros:
Cons:
|
2 | Object Storage | AWS S3-like storage can be used to persist diffs because audit events can be stored as plain-text (JSON) documents | Pros:
Cons:
|
2. Version history display: This should be done on demand comparing each diff of the entity to the previous
3. Changes to be tracked:
Changes in entity fields
Changes related to an update of the parent entity, e.g. holding update cascades to updates in items’ effective shelving order
Changes in metadata should be ignored
Key implementation aspects:
The Kafka default delivery semantics is “AT_LEAST_ONCE”. Ensure that domain events have their unique identifiers to be able to handle consuming messages in an idempotent manner
Add new consumers in
mod-audit
to inventory domain events for instances, items, and holdings.Add new consumers in
mod-audit
to authority domain events for authorities.Add new consumers in
mod-audit
to source record domain events for marc-bib records.(see: https://folio-org.atlassian.net/wiki/spaces/DD/pages/62685275)mod-audit
should support the following configurations on the tenant level:Retention period in years (with default value - 0 for indefinite retention)
Feature flag to enable audit capability. In case when the audit is disabled no consumers and logs should be persisted.
Anonymizing flag that indicates whether the records in the database should be anonymized before persistence to the database (To be confirmed).
mod-audit
should have the following scheduled jobs:Daily: to remove records that exceed the retention period
Monthly: to create subpartitions for audit tables
Persist audit events in an event storage. A table in DB per entity type with partitioning by UUID (hash) and subpartitioning by date range. E.g.:
instance_audit
table partitions:
-- main audit table
CREATE TABLE instance_audit
(
event_id uuid not null ,
event_date timestamp not null,
entity_id uuid not null,
origin varchar not null,
action varchar not null ,
user_id uuid not null,
diff jsonb,
primary key (event_id, event_date, entity_id)
) PARTITION BY HASH (entity_id);
-- main partitions
CREATE TABLE instance_audit_p0 PARTITION OF instance_audit FOR VALUES WITH (MODULUS 8, REMAINDER 0) PARTITION BY RANGE (event_date);
CREATE TABLE instance_audit_p1 PARTITION OF instance_audit FOR VALUES WITH (MODULUS 8, REMAINDER 1) PARTITION BY RANGE (event_date);
CREATE TABLE instance_audit_p2 PARTITION OF instance_audit FOR VALUES WITH (MODULUS 8, REMAINDER 2) PARTITION BY RANGE (event_date);
CREATE TABLE instance_audit_p3 PARTITION OF instance_audit FOR VALUES WITH (MODULUS 8, REMAINDER 3) PARTITION BY RANGE (event_date);
CREATE TABLE instance_audit_p4 PARTITION OF instance_audit FOR VALUES WITH (MODULUS 8, REMAINDER 4) PARTITION BY RANGE (event_date);
CREATE TABLE instance_audit_p5 PARTITION OF instance_audit FOR VALUES WITH (MODULUS 8, REMAINDER 5) PARTITION BY RANGE (event_date);
CREATE TABLE instance_audit_p6 PARTITION OF instance_audit FOR VALUES WITH (MODULUS 8, REMAINDER 6) PARTITION BY RANGE (event_date);
CREATE TABLE instance_audit_p7 PARTITION OF instance_audit FOR VALUES WITH (MODULUS 8, REMAINDER 7) PARTITION BY RANGE (event_date);
-- sub-partitions
CREATE TABLE instance_audit_p0_2025_q1 PARTITION OF instance_audit_p0 FOR VALUES FROM ('2025-01-01') TO ('2025-03-31');
CREATE TABLE instance_audit_p0_2025_q2 PARTITION OF instance_audit_p0 FOR VALUES FROM ('2025-04-01') TO ('2025-06-30');
CREATE TABLE instance_audit_p0_2025_q3 PARTITION OF instance_audit_p0 FOR VALUES FROM ('2025-07-01') TO ('2025-09-30');
CREATE TABLE instance_audit_p0_2025_q4 PARTITION OF instance_audit_p0 FOR VALUES FROM ('2025-10-01') TO ('2025-12-31');
CREATE TABLE instance_audit_p1_2025_q1 PARTITION OF instance_audit_p1 FOR VALUES FROM ('2025-01-01') TO ('2025-03-31');
CREATE TABLE instance_audit_p1_2025_q2 PARTITION OF instance_audit_p1 FOR VALUES FROM ('2025-04-01') TO ('2025-06-30');
CREATE TABLE instance_audit_p1_2025_q3 PARTITION OF instance_audit_p1 FOR VALUES FROM ('2025-07-01') TO ('2025-09-30');
CREATE TABLE instance_audit_p1_2025_q4 PARTITION OF instance_audit_p1 FOR VALUES FROM ('2025-10-01') TO ('2025-12-31');
CREATE TABLE instance_audit_p2_2025_q1 PARTITION OF instance_audit_p2 FOR VALUES FROM ('2025-01-01') TO ('2025-03-31');
CREATE TABLE instance_audit_p2_2025_q2 PARTITION OF instance_audit_p2 FOR VALUES FROM ('2025-04-01') TO ('2025-06-30');
CREATE TABLE instance_audit_p2_2025_q3 PARTITION OF instance_audit_p2 FOR VALUES FROM ('2025-07-01') TO ('2025-09-30');
CREATE TABLE instance_audit_p2_2025_q4 PARTITION OF instance_audit_p2 FOR VALUES FROM ('2025-10-01') TO ('2025-12-31');
CREATE TABLE instance_audit_p3_2025_q1 PARTITION OF instance_audit_p3 FOR VALUES FROM ('2025-01-01') TO ('2025-03-31');
CREATE TABLE instance_audit_p3_2025_q2 PARTITION OF instance_audit_p3 FOR VALUES FROM ('2025-04-01') TO ('2025-06-30');
CREATE TABLE instance_audit_p3_2025_q3 PARTITION OF instance_audit_p3 FOR VALUES FROM ('2025-07-01') TO ('2025-09-30');
CREATE TABLE instance_audit_p3_2025_q4 PARTITION OF instance_audit_p3 FOR VALUES FROM ('2025-10-01') TO ('2025-12-31');
CREATE TABLE instance_audit_p4_2025_q1 PARTITION OF instance_audit_p4 FOR VALUES FROM ('2025-01-01') TO ('2025-03-31');
CREATE TABLE instance_audit_p4_2025_q2 PARTITION OF instance_audit_p4 FOR VALUES FROM ('2025-04-01') TO ('2025-06-30');
CREATE TABLE instance_audit_p4_2025_q3 PARTITION OF instance_audit_p4 FOR VALUES FROM ('2025-07-01') TO ('2025-09-30');
CREATE TABLE instance_audit_p4_2025_q4 PARTITION OF instance_audit_p4 FOR VALUES FROM ('2025-10-01') TO ('2025-12-31');
CREATE TABLE instance_audit_p5_2025_q1 PARTITION OF instance_audit_p5 FOR VALUES FROM ('2025-01-01') TO ('2025-03-31');
CREATE TABLE instance_audit_p5_2025_q2 PARTITION OF instance_audit_p5 FOR VALUES FROM ('2025-04-01') TO ('2025-06-30');
CREATE TABLE instance_audit_p5_2025_q3 PARTITION OF instance_audit_p5 FOR VALUES FROM ('2025-07-01') TO ('2025-09-30');
CREATE TABLE instance_audit_p5_2025_q4 PARTITION OF instance_audit_p5 FOR VALUES FROM ('2025-10-01') TO ('2025-12-31');
CREATE TABLE instance_audit_p6_2025_q1 PARTITION OF instance_audit_p6 FOR VALUES FROM ('2025-01-01') TO ('2025-03-31');
CREATE TABLE instance_audit_p6_2025_q2 PARTITION OF instance_audit_p6 FOR VALUES FROM ('2025-04-01') TO ('2025-06-30');
CREATE TABLE instance_audit_p6_2025_q3 PARTITION OF instance_audit_p6 FOR VALUES FROM ('2025-07-01') TO ('2025-09-30');
CREATE TABLE instance_audit_p6_2025_q4 PARTITION OF instance_audit_p6 FOR VALUES FROM ('2025-10-01') TO ('2025-12-31');
CREATE TABLE instance_audit_p7_2025_q1 PARTITION OF instance_audit_p7 FOR VALUES FROM ('2025-01-01') TO ('2025-03-31');
CREATE TABLE instance_audit_p7_2025_q2 PARTITION OF instance_audit_p7 FOR VALUES FROM ('2025-04-01') TO ('2025-06-30');
CREATE TABLE instance_audit_p7_2025_q3 PARTITION OF instance_audit_p7 FOR VALUES FROM ('2025-07-01') TO ('2025-09-30');
CREATE TABLE instance_audit_p7_2025_q4 PARTITION OF instance_audit_p7 FOR VALUES FROM ('2025-10-01') TO ('2025-12-31');
Create REST API
4. to provide information on a list of changes related to a particular entity
5. to provide detailed information on the particular change - this API should use the Object diff library to return a verbose description of the changes related to the entityAs an audit log may be enabled when the inventory records are already present in the system the existing records should always show the
Created/Original Version
card in the UI. To achieve this when the UI fetches all audit records related to the entity and the earliest record is not aCreated
event then UI should get the date of creation from the current record metadata and display it in theCreated/Original Version
cardECS specific details:
Instance records promoted from ‘Local’ to ‘Shared’ should be reflected in the audit log with the event
Promoted
instead ofCreated
. To achieve this the audit consumers should listen to the topicCONSORTIUM_INSTANCE_SHARING_COMPLETE
(link)
ERD
With data size implications, creating separate tables per each entity type is required. The default table structure is listed below: