whatyouhide / plug_heartbeat

A plug for responding to heartbeat requests.

PlugHeartbeat

A tiny plug for responding to heartbeat requests.

Installation and docs

Documentation is available on hex.pm.

Add a dependency to your application's mix.exs file:

defp deps do
  [{:plug_heartbeat, "~> 1.0"}]
end

then run mix deps.get.

Usage

Just plug this plug (sorry) in your plug pipeline:

defmodule MyServer do
  use Plug.Builder
  plug PlugHeartbeat
  # ... rest of the pipeline
end

With this setup, all GET and HEAD requests to /heartbeat will return a 200 OK status and OK as the body. This path can be customized through the :path option:

defmodule MyServer do
  use Plug.Builder
  plug PlugHeartbeat, path: "/health"
  # ... rest of the pipeline
end

That's pretty much it, but the docs contain further details.

License

MIT © Andrea Leopardi, see the license file.

plug_heartbeat's Issues

Compilation error: function full_path/1 undefined

I included Trot in a project of mine, and plug_heartbeat comes as a dependency. Then I've got this error at compile time:

== Compilation error on file lib/plug_heartbeat.ex ==
** (CompileError) lib/plug_heartbeat.ex:48: function full_path/1 undefined
    (stdlib) lists.erl:1337: :lists.foreach/2
    (stdlib) erl_eval.erl:669: :erl_eval.do_apply/6

==> plug_heartbeat
could not compile dependency plug_heartbeat, mix compile failed. You can recompile this dependency with `mix deps.compile plug_heartbeat` or update it with `mix deps.update plug_heartbeat`

Which is weird because if I git clone & mix compile the repository, it compiles perfectly well.