KomachiHeartbeat v0.5.0 KomachiHeartbeat.Vital behaviour View Source

Behaviour which vital plugins implement.

defmodule ExampleVital do
  alias KomachiHeartbeat.Vital

  @behaviour Vital

  @impl Vital
  def init, do: nil

  @impl Vital
  def stats, do: {:ok, 42}

  @impl Vital
  def vital, do: :ok
end

Application.put_env(:komachi_heartbeat, :vitals, [ExampleVital])

Link to this section Summary

Types

stats()

Callbacks

init()

Initialize the vital.

stats()

Statistics. If it's not defined, use vital/0.

vital()

Vital.

Link to this section Types

stats()

stats() :: term()

Link to this section Callbacks

init()

init() :: any()

Initialize the vital.

stats()

stats() :: :ok | :error | {:ok | :error, stats()}

Statistics. If it's not defined, use vital/0.

vital()

vital() :: :ok | :error

Vital.