Cairnloop.Auditor behaviour (cairnloop v0.1.0)

Copy Markdown View Source

Behaviour for providing host application auditing to Cairnloop.

Cairnloop uses this behaviour to achieve compliance-grade, durable auditing. Host applications implement this behaviour to insert their own Ecto.Multi operations to log evidence within the same database transaction.

Summary

Callbacks

Injects an audit log operation into an existing Ecto.Multi pipeline.

Callbacks

audit(multi, action, actor, metadata)

@callback audit(
  multi :: Ecto.Multi.t(),
  action :: atom(),
  actor :: map() | String.t() | nil,
  metadata :: map()
) :: Ecto.Multi.t()

Injects an audit log operation into an existing Ecto.Multi pipeline.