BeamConsole.Config (beam_console v0.3.0)

Copy Markdown View Source

Resolves and validates bounded collector settings.

Collector application configuration rejects unknown keys so mistakes do not silently weaken runtime limits. Runtime adapters can also read individual resolved values through get/2.

Summary

Functions

collector(overrides \\ [])

Loads validated :beam_console, :collector configuration and applies overrides.

collector_keys()

Returns the supported collector configuration keys.

defaults()

Returns the default collector limits and sampling intervals.

get(options, key)

Returns an explicit option value or the corresponding default.

recorder(overrides \\ [])

Loads validated flight-recorder configuration with optional runtime overrides.

runtime_keys()

Returns the collector settings forwarded to the runtime adapter.

Functions

collector(overrides \\ [])

@spec collector(keyword()) :: keyword()

Loads validated :beam_console, :collector configuration and applies overrides.

Runtime overrides take precedence over application configuration.

collector_keys()

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

Returns the supported collector configuration keys.

defaults()

@spec defaults() :: keyword()

Returns the default collector limits and sampling intervals.

get(options, key)

@spec get(
  keyword(),
  atom()
) :: term()

Returns an explicit option value or the corresponding default.

recorder(overrides \\ [])

@spec recorder(keyword()) :: BeamConsole.Recorder.Config.t()

Loads validated flight-recorder configuration with optional runtime overrides.

runtime_keys()

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

Returns the collector settings forwarded to the runtime adapter.