Botica.Doctor.FlagsSummary (Botica v2.2.0)

Copy Markdown View Source

Formats Botica.Flags registry data into human-readable summaries.

Used by Botica.Doctor CLI / REPL wrappers to produce diagnostic banners.

Summary

Functions

Formats the snapshot/0 output as a human-readable string.

Returns a diagnostic snapshot of the current Botica.Flags registry.

Functions

format()

@spec format() :: String.t()

Formats the snapshot/0 output as a human-readable string.

Returns an empty string when no flags are defined.

Example

Flags (3 defined):
  ✓ beta_search     enabled  (default: true)
  ✗ new_dashboard   disabled (default: false)
  ~ rate_limiting   rollout 25% (default: false)

snapshot()

@spec snapshot() :: %{count: non_neg_integer(), flags: [map()]}

Returns a diagnostic snapshot of the current Botica.Flags registry.

Shape:

%{
  count: 3,
  flags: [
    %{name: :beta_search, status: :enabled, default: true, rollout: nil},
    %{name: :new_dashboard, status: :disabled, default: false, rollout: nil},
    %{name: :rate_limiting, status: :rollout, default: false, rollout: 25}
  ]
}