valiot/ecto_trail

EctoTrail allows to store Ecto changeset changes in a separate audit_log table.

EctoTrail

EctoTrail allows to store changeset changes into a separate audit_log table.

Installation and usage

1. Add ecto_trail to your list of dependencies in mix.exs:

def deps do
  [{:ecto_trail, "~> 0.2.0"}]
end

2. Ensure ecto_trail is started before your application:

def application do
  [extra_applications: [:ecto_trail]]
end

3. Add a migration that creates audit_log table to priv/repo/migrations folder:

defmodule EctoTrail.TestRepo.Migrations.CreateAuditLogTable do
  @moduledoc false
  use Ecto.Migration

  @table_name String.to_atom(Application.fetch_env!(:ecto_trail, :table_name))

  def change(table_name \\ @table_name) do
    EctoTrailChangeEnum.create_type
    create table(table_name) do
      add :actor_id, :string, null: false
      add :resource, :string, null: false
      add :resource_id, :string, null: false
      add :changeset, :map, null: false
      add(:change_type, :change)

      timestamps([type: :utc_datetime, updated_at: false])
    end
  end
end

4. Use EctoTrail in your repo:

defmodule MyApp.Repo do
  use Ecto.Repo, otp_app: :my_app
  use EctoTrail
end

5. Configure table name which is used to store audit log (in config.ex):

config :ecto_trail, table_name: "audit_log", redacted_fields: [:password, :token]

6. Use logging functions instead of defaults. See EctoTrail module docs.

Docs

The docs can be found at https://hexdocs.pm/ecto_trail.