ggpasqualino/plug_checkup

PlugCheckup provides a Plug for adding simple health checks to your app

plug_checkup's Issues

UndefinedFunctionError doesn't have a message field ** (KeyError) key :message not found in: %UndefinedFunctionError{...}

Not all exceptions have the field message.
There should be a call to Exception.message/1 instead of checking the field message of the exception when running PlugCheckup.Check.safe_execute/1

Catch exit and errors

Catch exit and errors besides rescuing exceptions

Accept plug pre-release version

https://hexdocs.pm/elixir/Version.html#module-requirements

Maintenance Status

I just wanted to ask about the maintenance status of this project: Is this library still actively maintained?

Otherwise, I would offer to further maintain this project.

Fix example in the README

forward "/health",
  to: PlugCheckup,
  init_opts: %PlugCheckup.Options{checks: [{MyHealthChecks, :check_db}, {MyHealthChecks, :check_redis}]}

the checks field should be a list of PlugCheckup.Check not a list of tuples

Add integration test

Add a test which goes through a plug router and checks whether the response is valid according to the json schema

Update version on mix.exs example

defp deps do
  [
    {:plug_checkup, "~> 0.1.0"}
  ]
end

should contain newest version of library

Docs unclear on Phoenix usage

In the docs it says

Forward your health path to PlugCheckup in your Plug Router

forward "/health",
  to: PlugCheckup,
  init_opts: %PlugCheckup.Options{checks: checks}

This can be confusing when using Phoenix as the Phoenix.Router implements a different forward/4 function that takes a different set of arguments than forward/2 in Plug.Router.

Happy to add an example if you think it's worth it.

Make response pretty

Make the json response pretty formatted.
Add field pretty to Options with default true to be used on the encoding of the json response.

Receive time unit as option

Validate options

Validate the Options given to the plug, raise exception in case it is not, in order to avoid the application to start with wrong configuration.

• timeout: integer
• checks: list(PlugCheckup.Check)
• pretty: boolean