# Commanded audit middleware
Command auditing middleware for [Commanded](https://github.com/commanded/commanded) CQRS/ES applications.
Records every dispatched command to the configured database storage. Includes whether the command was successfully handled, or any error.
Please refer to the [CHANGELOG](CHANGELOG.md) for features, bug fixes, and any upgrade advice included for each release.
MIT License
[](https://travis-ci.org/commanded/commanded-audit-middleware)
---
## Installation
1. Add `commanded_audit_middleware` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:commanded_audit_middleware, "~> 0.2"},
]
end
```
2. Add the following config section to `config/config.exs`:
```elixir
config :commanded_audit_middleware,
ecto_repos: [Commanded.Middleware.Auditing.Repo],
serializer: Commanded.Serialization.JsonSerializer
```
3. Add the following config section to each environment's config (e.g. `config/dev.exs`):
```elixir
config :commanded_audit_middleware, Commanded.Middleware.Auditing.Repo,
adapter: Ecto.Adapters.Postgres,
database: "commanded_audit_middleware_dev",
username: "postgres",
password: "postgres",
hostname: "localhost",
port: "5432"
```
4. Fetch and compile mix dependencies:
```console
$ mix do deps.get, deps.compile
```
5. Create and migrate the command audit database:
```console
$ mix ecto.create -r Commanded.Middleware.Auditing.Repo
$ mix ecto.migrate -r Commanded.Middleware.Auditing.Repo
```
6. Add the middleware to your application's Commanded router.
```elixir
defmodule Router do
use Commanded.Commands.Router
middleware Commanded.Middleware.Auditing
end
```
