@spec broadcast_interval() :: pos_integer()

Milliseconds between live PubSub broadcasts of touched counters.

@spec clock() :: module()

The configured clock. Every instant and date in lib/ comes from it.

@spec cluster_sync?() :: boolean()

Whether nodes exchange deltas and totals so counters are cluster-wide (default true).

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

Currency code for new credit balance rows (default "usd").

@spec credits_hold_reconciler() ::
  module() | {module(), atom()} | (map() -> term()) | nil

How AuroraMeter.Credits.reconcile_holds/1 decides about a stale hold.

nil, the default, means every hold is kept. That is the value a host that has never heard of this key has, and it is why upgrading cannot release money.

Examples

iex> AuroraMeter.Config.credits_hold_reconciler()
nil

@spec credits_hold_reconciler_timeout() :: pos_integer()

Milliseconds one AuroraMeter.Credits.HoldReconciler.decide/1 call may take.

Examples

iex> AuroraMeter.Config.credits_hold_reconciler_timeout()
5000

@spec credits_low_balance_handler() :: (map() -> term()) | nil

The low-balance callback (fun/1), or nil.

@spec credits_low_balance_handler_timeout() :: pos_integer()

Milliseconds one :credits_low_balance_handler call may take before it is killed.

Examples

iex> AuroraMeter.Config.credits_low_balance_handler_timeout()
5000

@spec credits_low_balance_threshold() :: integer() | nil

Default low-balance threshold in micro-dollars, or nil for none.

@spec credits_overdraft_tolerance() :: non_neg_integer()

Micro-dollars the available credit balance may go below zero on a hold or debit (default 0).

@spec default_plan() :: atom()

The plan id used for tenants with no subscription.

@spec durable_features() :: [atom()]

Features that also write a durable event row on every track.

@spec events_future_tolerance() :: non_neg_integer()

Seconds an occurred_at may run ahead of the node clock before it is refused.

@spec events_outbox() :: module() | nil

The configured AuroraMeter.Events.Outbox implementation, or nil for none.

@spec feature_source(atom()) :: :buffered | :events

Where feature's commercial quantity comes from: :buffered or :events.

Anything the configuration does not name is :buffered, which is every feature in 0.4.x and the default in 1.0. This is the one seam that answers the question: the AuroraMeter.track/4 and AuroraMeter.reserve/2,3 guards, the AuroraMeter.with_quota/4 commit rule, cold seeding and the record path's export eligibility all read it here rather than each consulting the map.

The source is a boot-time property. It is read from the cache validate!/0 fills, so changing :feature_sources at runtime changes nothing on this node until it is validated again. That is deliberate: a source that could change between two calls in one period is precisely the double-count this key exists to prevent.

Examples

iex> AuroraMeter.Config.feature_source(:ai_generations)
:buffered

@spec feature_sources() :: %{required(atom()) => :buffered | :events}

The :feature_sources map as configured.

This is the declaration. feature_source/1 is what is in force on this node, which is the declaration as it stood at the last validate!/0; the two differ only for a host that rewrites the key at runtime, which is documented in Metering as unsupported.

@spec flush_interval() :: pos_integer()

Milliseconds between durable flushes of dirty counters to the database.

@spec flush_node_id() :: String.t() | nil

The configured identity for this node's "flush:<node>" heartbeat row, or nil when nothing is configured.

nil means "use to_string(node())", which AuroraMeter.Retention.node_id/0 resolves. It is not resolved here because a default is written once, in the schema, and node() is not a value a compile-time schema can hold.

On an unnamed VM node() is :nonode@nohost for every node, so several unnamed VMs sharing one database write one heartbeat row between them, which cannot distinguish one node from ten. AuroraMeter.Retention logs a warning when it sees that name.

Examples

iex> AuroraMeter.Config.flush_node_id()
nil

@spec flush_receipt_retention() :: pos_integer()

Days a flush receipt is kept before AuroraMeter.Retention may delete it (default 30, floor 1 day).

Examples

iex> AuroraMeter.Config.flush_receipt_retention()
30

@spec history?() :: boolean()

Whether UTC day buckets are maintained for AuroraMeter.history/3 (default true).

@spec live_view_tenant() :: {module(), atom()} | nil

The {module, function} pair on_mount {AuroraMeter.LiveView, :subscribe} calls to resolve the tenant, or nil when the host passes a resolver at the mount instead.

Examples

iex> AuroraMeter.Config.live_view_tenant()
nil

@spec metrics_feature_label?() :: boolean()

Whether the metrics presets tag on :feature (default false).

Examples

iex> AuroraMeter.Config.metrics_feature_label?()
false

@spec metrics_interval() :: non_neg_integer()

Milliseconds between gauge samples, or 0 for no internal timers.

Returns whatever the host configured. The default is 10_000, and this repository's own test configuration sets 0, which is why the figure is stated here rather than shown as an example: an example that asserts a configured value is a test of the configuration it happens to run under.

@spec metrics_scan_ceiling() :: non_neg_integer()

The largest counters table the cluster lag gauge will scan for unreconciled_keys; above it the measurement is omitted rather than zeroed.

Examples

iex> AuroraMeter.Config.metrics_scan_ceiling()
50_000

@spec period_source() :: module()

The configured period source.

@spec plan_version_conflict() :: :raise | :warn

Whether an edited plan version refuses the boot or logs.

Examples

iex> AuroraMeter.Config.plan_version_conflict() in [:raise, :warn]
true

@spec plans() :: module()

The configured plans module.

@spec policy_for(atom()) :: :allow | :warn | :deny | :raise

The undeclared-feature policy in force for feature.

In V1 every feature gets the global :undeclared_feature_policy. It is a function rather than a key read so that the durable-event writers arriving in 1.0 (record and correct) consult one seam, and so a per-feature map later is a change in one place.

Examples

iex> AuroraMeter.Config.policy_for(:ai_generations) in [:allow, :warn, :deny, :raise]
true

@spec provider() :: module()

The configured billing provider.

@spec pubsub() :: atom()

The configured host Phoenix.PubSub server name.

@spec record_max_concurrency() :: pos_integer()

How many callers may hold an open record transaction at once.

@spec record_timeout() :: pos_integer()

Milliseconds one durable write may take before it is {:unavailable, :timeout}.

@spec replay_checkpoint_retention() :: pos_integer()

Days a finished replay checkpoint row is kept (default 365, floor 1 day).

Examples

iex> AuroraMeter.Config.replay_checkpoint_retention()
365

@spec repo() :: module()

The configured host Ecto repo.

@spec storage() :: module()

The configured storage adapter.

@spec subscription_cache_ttl() :: non_neg_integer()

Milliseconds a subscription lookup stays cached (default 5_000; 0 disables).

@spec tenant() :: module()

The configured tenant-resolution module.

@spec undeclared_feature_policy() :: :allow | :warn | :deny | :raise

What the entitlement functions do with a feature the tenant's plan does not declare.

@spec validate!() :: keyword()

Validates the current :aurora_meter configuration, raising on any problem.

Returns the validated options (with defaults applied) on success.

Examples

iex> is_list(AuroraMeter.Config.validate!())
true