Real-time terminal dashboard for Caddy servers, with built-in FrankenPHP support
Real-time terminal dashboard for Caddy servers, with built-in FrankenPHP support
Monitor your Caddy server in real time: per-host traffic, latency percentiles, status codes, and more. When FrankenPHP is detected, unlock per-thread introspection, worker management, and memory tracking. It is officially recommended by FrankenPHP.
Caddy exposes rich metrics through its admin API and Prometheus endpoint, but reading raw Prometheus text or setting up a full Grafana stack just to glance at traffic is heavy. Ember gives you a zero-config, read-only terminal dashboard that connects to Caddy's admin API and works out of the box. No extra infrastructure, no YAML to write: just ember and you're monitoring.
Caddy Monitoring
reverse_proxy is configured__ember__ for access logs, __ember_runtime__ for everything else) and receives logs over TCP with no Caddyfile changes, or streams them directly from standard input (stdin)FrankenPHP Introspection
Integration & Operations
/metrics) with optional basic auth and health endpoint (/healthz)--daemon, --json, status, wait, init, and diff modes: a single Ember process aggregates several Caddy instances behind one Prometheus endpoint with an ember_instance label, per-instance TLS material, and per-instance polling cadenceember_* metrics (build info, per-stage scrape totals, errors, durations, last success) so you can monitor the monitor--once for single snapshotsember status (text or --json) for a one-line Caddy summaryember wait blocks until Caddy is up (-q for silent scripting; supports repeated --addr with --any for first-ready semantics)ember diff before.json after.json compares snapshots (single-instance JSON or multi-instance JSONL, with one diff block per instance)ember init checks Caddy, enables metrics, and warns about missing host matchersadmin unix//pathEMBER_ADDR, EMBER_EXPOSE, EMBER_LOG_LISTEN, EMBER_STDIN_LOGS, ...) for container deployments.ember.toml): declare a fleet of named endpoints once instead of repeating --addr. The TUI connects to one (a saved default or an interactive picker); --daemon, --json, status, wait, and init fan out across all of them. ember config use sets the TUI defaultNO_COLOR env var support (no-color.org)curl -fsSL https://raw.githubusercontent.com/alexandre-daubois/ember/main/install.sh | shOr with Homebrew:
brew install alexandre-daubois/tap/embermacOS: if Gatekeeper blocks the binary on first run, remove the quarantine attribute:
xattr -d com.apple.quarantine $(which ember), or allow it manually in System Settings → Privacy & Security.
Or with Go:
go install github.com/alexandre-daubois/ember/cmd/ember@latestOr with Docker (runs in daemon mode by default, see Docker docs):
docker run --rm --network host alexandredaubois/emberThe image is also mirrored on GHCR as ghcr.io/alexandre-daubois/ember.
You can also download the latest binaries from the release page. If you use this method, don't forget to check for updates regularly!
Make sure Caddy is running with the admin API enabled (it is by default). Then:
ember initThis checks your Caddy setup and enables metrics via the admin API if needed (no restart required). Once ready:
emberEmber connects to the Caddy admin API and auto-detects FrankenPHP if present.
For a quick one-line health check:
ember statusEmber polls the Caddy admin API and Prometheus metrics endpoint at a regular interval (default: 1s), computes deltas and derived metrics (RPS, percentiles, error rates), and renders them through one of several output modes: an interactive Bubble Tea TUI (default), streaming JSONL, a headless daemon with Prometheus export, or a one-shot status command.
Ember supports a plugin system that lets third-party developers add custom tabs for visualizing metrics from additional Caddy modules (e.g., rate limiters, WAF modules, custom middleware). Plugins are compiled into the binary using Go's blank import pattern, the same approach used by Caddy itself.
Building a custom Ember binary with plugins is simple:
import (
"github.com/alexandre-daubois/ember"
_ "github.com/myorg/ember-myplugin"
)
func main() { ember.Run() }Plugins can provide multiple tabs, subscribe to core metrics, conditionally hide their tabs, and reuse Ember's Prometheus parser via the pkg/metrics package.
See the Plugin Development Guide for details on building and integrating plugins.
The plugin API is still evolving: feedback is very welcome. If something does not fit your use case or you wish an interface exposed more (or less), please open an issue and tell us what you are trying to build.
Full documentation is available in the docs/ directory:
See CONTRIBUTING.md for development setup, architecture overview, and guidelines.
MIT
No open issues yet, or sync has not completed.