CodeNameRaven.Monitor.Assertion (raven_observer_sdk v0.6.0)

Copy Markdown

A generic assertion framework for monitoring integrations. Allows operators to define configurable health check thresholds.

Summary

Types

operator()
outcome()
t()

Functions

evaluate(assertion, results)

Evaluates a single assertion against the results map.

evaluate_all(assertions, results)

Evaluates all assertions against the results map, returning a combined status and a list of failure reason messages.

parse(list)

Parses a list of assertion maps (as received from params) into a list of Assertion structs.

Types

operator()

@type operator() ::
  :eq
  | :ne
  | :lt
  | :lte
  | :gt
  | :gte
  | :contains
  | :not_contains
  | :matches
  | :in
  | :present
  | {:unrecognized, String.t()}

outcome()

@type outcome() :: :pass | {:fail, :down | :degraded, String.t()}

t()

@type t() :: %CodeNameRaven.Monitor.Assertion{
  operator: operator(),
  severity: :down | :degraded | {:unrecognized, String.t()},
  target: String.t() | nil,
  type: String.t(),
  value: term()
}

Functions

evaluate(assertion, results)

@spec evaluate(t(), map()) :: outcome()

Evaluates a single assertion against the results map.

evaluate_all(assertions, results)

@spec evaluate_all([t()], map()) :: {:up | :degraded | :down, [String.t()]}

Evaluates all assertions against the results map, returning a combined status and a list of failure reason messages.

parse(list)

@spec parse([map()]) :: [t()]

Parses a list of assertion maps (as received from params) into a list of Assertion structs.