qgadrian / metadata_plugs

Elixir plugs to provide metadata information

MetadataPlugs

Collection of plugs to provide different metadata information.

Plugs included:

• Health
• Info

Installation

Add to dependencies

def deps do
  [{:metadata_plugs, "~> 0.3.2"}]
end

Install dependencies

mix deps.get

Plugs

Health

Just add the plug to the endpoint file

plug(MetadataPlugs.Health)

Default path for this plug is /health, which can be overwritten:

plug(MetadataPlugs.Health, path: "/healthz")

Info

Add the plug to the endpoint file with the desired environment variables to get the info from.

plug(MetadataPlugs.Info, env_vars: ["APP_VERSION", "ENVIRONMENT"])

Default path for this plug is /info, which can be overwritten:

plug(MetadataPlugs.Info, path: "/infoz")