PhoenixHealthy.Router (phoenix_healthy v0.1.0)

Copy Markdown View Source

Router helper for mounting health probes in a Phoenix application.

import PhoenixHealthy.Router

phoenix_healthy("/health", repo: MyApp.Repo)

This defines GET <path>/live and GET <path>/ready.

Summary

Functions

Mounts liveness and readiness routes under path.

Functions

phoenix_healthy(path, opts \\ [])

(macro)

Mounts liveness and readiness routes under path.

Options are forwarded to PhoenixHealthy (:repo, :live, :ready, :ok_body, :error_body, and so on). Pass :controller to use your own controller instead of PhoenixHealthy.Controller.