# `QueueKeeperCheck.Report`
[🔗](https://github.com/TitaniumMonkey/Queue-keeper-check/blob/v0.2.1/lib/queue_keeper_check/report.ex#L1)

Result of `QueueKeeperCheck.run/2`.

* `:status` - `:ok`, `:warning`, `:critical`, or `:error` when at least one check could
  not complete (and no finding is critical). See `QueueKeeperCheck.Release.exit_code/1`.
* `:findings` - `QueueKeeperCheck.Finding` structs
* `:errors` - one map per check that failed: `%{check: atom | nil, error: String.t(),
  message: String.t()}`. `error` is the exception module; `message` is the first line of
  the exception message, truncated. Query parameters and connection options are never
  included.

# `error`

```elixir
@type error() :: %{check: atom() | nil, error: String.t(), message: String.t()}
```

# `t`

```elixir
@type t() :: %QueueKeeperCheck.Report{
  checked_at: DateTime.t(),
  errors: [error()],
  findings: [QueueKeeperCheck.Finding.t()],
  status: :ok | :warning | :critical | :error
}
```

---

*Consult [api-reference.md](api-reference.md) for complete listing*