Breeze.Timeline (Breeze Timeline v0.1.0)

Copy Markdown View Source

Public API for an opt-in Breeze runtime timeline.

Breeze.Server.start_link(
  view: MyApp.View,
  inspector: [
    pages: [
      {Breeze.Timeline.Page,
       every: 5,
       limit: 60,
       include: [:frame, :inspector]}
    ]
  ]
)

Breeze.Timeline.Hook supports:

  • :every - capture every N matching renders. Defaults to 1.
  • :limit - retained checkpoints per server. Defaults to 120.
  • :include - checkpoint attachments. Defaults to [:frame, :inspector].
  • :modes - render modes to capture, :full and/or :patch.
  • :exclude_causes - render causes to ignore.
  • :timeout - timeout for capturing each view process. Defaults to 5_000 milliseconds.

No capture occurs unless the timeline page contributes its hook (or the hook is configured directly as standalone runtime tooling).

Summary

Functions

Displays a retained checkpoint frame in the source application.

Replaces the source application's runtime with a retained checkpoint.

Returns lightweight timeline entries for a server.

Functions

display_frame(server_pid, selection, opts \\ [])

Displays a retained checkpoint frame in the source application.

Pass "latest" or :live to restore the application's current frame.

rewind(server_pid, entry_id, opts \\ [])

Replaces the source application's runtime with a retained checkpoint.

Newer timeline entries are discarded. The restored runtime remains paused until the next source-application interaction.

timeline(server_pid)

Returns lightweight timeline entries for a server.

Full runtime checkpoints and captured frame contents remain on the source node.