A single entry in a recording's timeline.
at is the offset in milliseconds from the moment recording started.
The shape of data depends on type:
:mount—%{assigns: map}, the assigns when recording started:event—%{name: String.t(), params: map}, ahandle_event/3call; events handled by a LiveComponent also carrytarget: {module, id}:params—%{params: map, uri: String.t()}, ahandle_params/3call:info—%{tag: atom | nil}, ahandle_info/2call; only the message tag is kept so arbitrary message contents are never stored:render—%{assigns: map}, the assigns changed by a render:component—%{module: module, id: term, assigns: map}, the assigns of a LiveComponent changed by an update or event:component_destroyed—%{module: module, id: term}, a LiveComponent removed from the page:telemetry— `%{event: [atom], summary: String.t()nil, language: :sql nil, measurements: map, metadata: map, error: String.t() | nil, mark: boolean | String.t()}
, a telemetry event captured by aPhoenixReplay.Collector;languageis what the summary is written in, andmark` whether it marks a moment, or the mark's name, both absent from events recorded before 0.6:log—%{level: Logger.level(), message: String.t(), metadata: map}, a log message, seePhoenixReplay.Capture.Logs:exit—%{reason: String.t()}, the LiveView process exited abnormally:viewport—%{width: integer, height: integer, dpr: number}, the browser's viewport changed: once a resize or rotation settled, or with the user's next interaction whenreplayRecorderdoes not run:pointer— a batch of pointer moves, presses and scroll offsets, when:pointeris configured; seePhoenixReplay.Capture.PointerandPhoenixReplay.Recording.PointerTrack:state— state reported by code in the browser, seePhoenixReplay.Capture.State. Stored as a batch,%{span: integer, entries: [[dt, key, changes]]};PhoenixReplay.Recording.State.spread/1turns it into one:stateevent per entry,%{key: String.t(), changes: map}, for replay
:telemetry, :log and :exit events describe what happened around
the view; they do not change the replayed state.
Summary
Functions
The assigns an event set: a mount's or render's, or the client state an entry reported.
Duration in milliseconds of a telemetry event, if it has one.
Returns true for an exit, an error log, or a telemetry event that captured an error.
One line describing the event; see PhoenixReplay.Recording.Label.
Returns true for a telemetry event that marks a moment, such as a signup,
rather than measuring work; see PhoenixReplay.Collector.Captured.
The name of the moment an event marks: the name its collector gave it,
or else its telemetry event's name joined with dots, such as
"my_app.checkout.completed". nil for events that mark nothing.
Types
@type t() :: %PhoenixReplay.Recording.Event{ at: non_neg_integer(), data: map(), type: type() }
@type type() ::
:mount
| :event
| :params
| :info
| :render
| :component
| :component_destroyed
| :telemetry
| :log
| :exit
| :viewport
| :pointer
| :state
Functions
The assigns an event set: a mount's or render's, or the client state an entry reported.
Duration in milliseconds of a telemetry event, if it has one.
Returns true for an exit, an error log, or a telemetry event that captured an error.
One line describing the event; see PhoenixReplay.Recording.Label.
Returns true for a telemetry event that marks a moment, such as a signup,
rather than measuring work; see PhoenixReplay.Collector.Captured.
The name of the moment an event marks: the name its collector gave it,
or else its telemetry event's name joined with dots, such as
"my_app.checkout.completed". nil for events that mark nothing.