API Reference chronicle v#0.1.0

Copy Markdown

Modules

Tamper-evident audit facts and restorable Ecto record versions.

Versioned, deterministic encoding for integrity-protected audit data.

Persistence boundary for independently anchored verification checkpoints.

In-memory checkpoint store for tests and local development.

Built-in result-to-audit-outcome classifiers.

Resolves named audit stores.

Carries audit identity and correlation data through the current process.

Low-level conversion of completed Ecto operations into version events.

Verifies the Ecto audit ledger and returns an anchorable checkpoint.

Reusable Ecto migration for the default audit store.

Schema-local change selection and protection policy.

Stable, structured error returned by the ergonomic audit APIs.

A single immutable audit fact.

The durable envelope for a larger audited unit of work.

On-demand operational health for one named audit store.

Converts domain values into small, stable audit references.

Hash-chain and HMAC primitives for tamper-evident audit ledgers.

A ledger position suitable for anchoring outside the audit database.

Cryptographic commitment to one append-only audit ledger unit.

A signing key descriptor with an explicit ledger sequence epoch.

Behaviour and dispatcher for versioned audit signing keys.

Keyring backed by the audit store's integrity keyword configuration.

Reports the signing keys required to verify a named audit store.

Audited operations for an ordinary Ecto.Multi.

Propagates audit context through Oban-compatible job arguments.

Builds audit context from a Plug.Conn.

Adds request, actor, and correlation information to Chronicle.Context.

Behaviour implemented by audit storage providers.

Stores audit groups and events in an Ecto repository.

An in-memory provider intended for tests and local development.

Read API for Ecto-backed audit timelines.

A tagged event or group returned by Chronicle.Query.timeline/2.

One stable, cursor-addressed page of audit timeline items.

Central protection policy for event data and Ecto record snapshots.

A resolved protection policy.

Optional audit policy for an Ecto schema.

Resolved configuration for a named audit destination.

Task helpers that propagate the current audit context and active group.

Lightweight capture and inspection helpers for application tests.

Periodically verifies a named store against independently persisted anchors.

One immutable, signed version of an Ecto record.

Mix Tasks

Starts the application and checks a configured named audit store.

Generates a host migration and config/audit.runtime.exs.example.

Verifies the complete named store and generates replacement key material. By default it does not mutate the ledger, configuration, or a secret manager.