Fettle Plug

Plug support for Fettle health-checks.

Getting Started

Installation

def deps do
  [
    {:fettle_plug, "~> 0.1"}
  ]
end

For the latest (and most unstable) version:

def deps do
  [
    {:fettle_plug, github: "Financial-Times/fettle_plug"}
  ]
end

fettle_plug has a transitive dependency on fettle.

Setup

In your Plug pipeline (Phoenix.Endpoint etc.), forward to the Fettle.Plug module to serve your results from your desired URL:

Plug example:

use Plug.Router
plug :match
plug :dispatch

forward "/__health", to: Fettle.Plug, init_opts: [schema: Fettle.Schema.FTHealthCheckV1]

In a Phoenix Router, it's pretty much the same:

forward "/__health", Fettle.Plug, schema: Fettle.Schema.FTHealthCheckV1

Note in both examples above, the specification of the schema is optional, since Fettle.Schema.FTHealthCheckV1 is the default.