TimelessPhoenix.Router (timeless_phoenix v1.5.14)

Copy Markdown View Source

Router macro for one-line LiveDashboard setup with all observability pages.

Usage

defmodule MyAppWeb.Router do
  use Phoenix.Router
  import TimelessPhoenix.Router

  pipeline :browser do
    plug :fetch_session
    plug :protect_from_forgery
    plug :put_secure_browser_headers
  end

  scope "/" do
    pipe_through :browser
    timeless_phoenix_dashboard "/dashboard"
  end
end

Options

  • :name — TimelessPhoenix instance name (default: :default)
  • :metrics — metrics module passed to LiveDashboard (default: TimelessPhoenix.DefaultMetrics)
  • :download_path — path for backup downloads (default: "/timeless/downloads")
  • :live_dashboard — extra opts merged into live_dashboard call

Summary

Functions

Mounts the TimelessMetricsDashboard download plug and LiveDashboard with all pages.

Functions

timeless_phoenix_dashboard(path, opts \\ [])

(macro)

Mounts the TimelessMetricsDashboard download plug and LiveDashboard with all pages.