BeamConsole.Coverage (beam_console v0.5.0)

Copy Markdown View Source

Records how complete and expensive a runtime snapshot was.

Limits and vanished processes are represented explicitly so callers can distinguish a complete snapshot from a bounded or partial one.

Summary

Functions

Classifies snapshot coverage for recorder history and runtime presentation.

Returns human-readable reasons that a runtime sample has incomplete coverage.

Types

state()

@type state() :: :complete | :partial | :truncated

t()

@type t() :: %BeamConsole.Coverage{
  duration_ms: non_neg_integer(),
  inspected_pids: non_neg_integer(),
  partial_supervisors: non_neg_integer(),
  process_limit_reached?: boolean(),
  total_pids: non_neg_integer(),
  traversal_limit_reached?: boolean(),
  vanished_pids: non_neg_integer(),
  warnings: [String.t()]
}

Functions

state(coverage)

@spec state(t()) :: state()

Classifies snapshot coverage for recorder history and runtime presentation.

warnings(coverage)

@spec warnings(t()) :: [String.t()]

Returns human-readable reasons that a runtime sample has incomplete coverage.