Provides an outage-safe boundary around the lifecycle recorder.
Expected process exits during supervisor restart windows become structured unavailable results so connected LiveViews can preserve their bounded view.
Summary
Functions
Returns bounded lifecycle events when the recorder process is available.
Pauses recording when the recorder process is available.
Resumes recording when the recorder process is available.
Returns bounded aggregate samples when the recorder process is available.
Returns recorder health when the recorder process is available.
Types
@type query_error() :: unavailable() | {:error, {:invalid_query_options, term()}}
@type server() :: GenServer.server() | nil
Functions
@spec events( keyword(), server() ) :: {:ok, BeamConsole.Recorder.Query.t()} | query_error()
Returns bounded lifecycle events when the recorder process is available.
@spec pause(server()) :: {:ok, BeamConsole.Recorder.Status.t()} | unavailable()
Pauses recording when the recorder process is available.
@spec resume(server()) :: {:ok, BeamConsole.Recorder.Status.t()} | unavailable()
Resumes recording when the recorder process is available.
@spec samples( keyword(), server() ) :: {:ok, BeamConsole.Recorder.Query.t()} | query_error()
Returns bounded aggregate samples when the recorder process is available.
@spec status(server()) :: {:ok, BeamConsole.Recorder.Status.t()} | unavailable()
Returns recorder health when the recorder process is available.