# AuditLog v0.1.0 - Table of Contents

> Explicit semantic audit events for Ecto and PostgreSQL

## Pages

- [AuditLog](readme.md)
- [Temporal subjects](temporal_subjects.md)
- [Limits and operations](limits.md)
- [Changelog](changelog.md)
- [Roadmap](roadmap.md)

## Modules

- [AuditLog](AuditLog.md): Writes explicit semantic audit events through an Ecto repository.

- Value objects
  - [AuditLog.Actor](AuditLog.Actor.md): A durable snapshot of the person or service responsible for an event.
  - [AuditLog.Context](AuditLog.Context.md): Explicit actor, correlation, causation, and shared metadata for audit events.
  - [AuditLog.Subject](AuditLog.Subject.md): A durable subject identity and optional exact temporal version boundary.

- Storage
  - [AuditLog.Event](AuditLog.Event.md): The stored representation of one semantic audit event.
  - [AuditLog.Migration](AuditLog.Migration.md): Installs and removes the PostgreSQL objects used by `AuditLog`.
  - [AuditLog.Query](AuditLog.Query.md): Composable Ecto queries for audit timelines.

## Mix Tasks

- [mix audit_log.gen.migration](Mix.Tasks.AuditLog.Gen.Migration.md): Generates a reversible Ecto migration that installs AuditLog

