mix timeless_phoenix.install (timeless_phoenix v1.5.12)

Copy Markdown View Source

Installs TimelessPhoenix into your application.

Adds TimelessPhoenix to your supervision tree, configures your Phoenix router with all observability dashboard pages, and updates the formatter.

Usage

mix igniter.install timeless_phoenix
mix igniter.install timeless_phoenix --storage memory

Options

  • --storage — disk (default) or memory. Disk mode persists logs and traces with indexing and retention management. Memory mode keeps them in RAM only and loses them on restart. Metrics are always persisted to disk.
  • --http — Enable HTTP ingest/query endpoints for metrics, logs, and traces.
  • --http-metrics — Enable only the metrics HTTP endpoint.
  • --http-logs — Enable only the logs HTTP endpoint.
  • --http-traces — Enable only the traces HTTP endpoint.
  • --metrics-port — Port for the metrics HTTP endpoint (default 8428).
  • --logs-port — Port for the logs HTTP endpoint (default 9428).
  • --traces-port — Port for the traces HTTP endpoint (default 10428).

What it does

  1. Adds {TimelessPhoenix, ...} to your application's supervision tree (logs, traces, and metrics persist to disk by default)
  2. Configures OpenTelemetry to export spans to TimelessTraces
  3. Adds import TimelessPhoenix.Router to your Phoenix router
  4. Adds timeless_phoenix_dashboard "/dashboard" to your router's browser scope
  5. Adds :timeless_phoenix to your .formatter.exs import_deps
  6. Removes the default live_dashboard route (avoids live_session conflict)