Framework.OverlayController (Framework v0.5.0)

View Source

Framework debug overlay controller functions.

This module provides controller action functions that host Phoenix applications can delegate to for overlay functionality. Host applications should create their own controller that delegates to these functions.

Usage in host application

defmodule MyAppWeb.OverlayController do
  use MyAppWeb, :controller

  defdelegate index(conn, params), to: Framework.OverlayController
  defdelegate timeline(conn, params), to: Framework.OverlayController
  # ... other actions
end

All functions return data structures that can be rendered as JSON or HTML by the host application's controller.

Summary

Functions

Dead Letter Queue browser for failed effects.

Export and diagnostic bundle creation.

Main overlay dashboard with system overview.

Real-time metrics API endpoint.

Outbox browser for event sequence inspection.

Replay harness for event replay testing.

Routes inspector for AppSpec debugging.

Supersedence visualizer for navigation debugging.

Timeline view showing Accept → Plan → Commit → Emit flow.

Functions

dlq(conn, params)

Dead Letter Queue browser for failed effects.

dlq_replay(conn, map)

export(conn, params)

Export and diagnostic bundle creation.

export_bundle(conn, params)

index(conn, params)

Main overlay dashboard with system overview.

metrics_api(conn, params)

Real-time metrics API endpoint.

outbox(conn, params)

Outbox browser for event sequence inspection.

outbox_event(conn, map)

replay(conn, params)

Replay harness for event replay testing.

replay_from(conn, map)

routes(conn, params)

Routes inspector for AppSpec debugging.

routes_inspect(conn, map)

supersedence(conn, params)

Supersedence visualizer for navigation debugging.

timeline(conn, params)

Timeline view showing Accept → Plan → Commit → Emit flow.

timeline_request(conn, map)