Event logging

This is a preview feature, the API can change in future releases. Use for test and feedback.

The system is build around a persistent, append-only event log. Each operation that changes the system produces an event. 

Besides being logged persistently in the database, the log is also printed to file or console. The output is formatted according to the Common Event Format (CEF) standard.

Control the log output with the com.phenixidentity.digo.vertx.core.logging.cef.CefHandler logger in the Log4j configuration file. By default, the event log is printed to the file logs/events.log.

Below is a list of all available events:

Event ID Description
LOGIN_CREATED
A new login created (first time login)
ORDER_CREATED
An order created
ORDER_ACCEPTED
An order accepted (all signers have signed)
ORDER_SIGNED
A signature added to an order
ORDER_REJECTED
A signer rejected the order
ORDER_CANCELED
A solicitor canceled the order
ORDER_EXPIRED
An order reached expiry without being accepted
ORDER_DELETED An order has been deleted from the database
DOCUMENT_EXPIRED
A document reached expiry (eligible for retention)
DOCUMENT_CREATED
A document created
DOCUMENT_DELETED Document metadata has been deleted from the database.
ORDER_DOCUMENT_UPDATED
An order was assigned a new document
ORDER_DUE_DATE_UPDATED
The due date of an order was updated
USER_STATE_CHANGED
A user marked as notified
USER_ALERT
A user marked as reminded
SENDING_EMAIL
The system about to send email
SESSION_STARTED
A user logged in