ping_plug

A simple plug to echo message back, useful with healthcheck endpoint where you just need to response 200 ok.


Keywords
echo-message, elixir, elixir-plug, health-check
License
MIT

Documentation

PingPlug

CI/CD Hex.pm

A simple Elixir plug to echo message

Installation

The package can be installed as:

Add ping_plug to your list of dependencies in mix.exs:

def deps do
  [{:ping_plug, "~> 0.1.0"}]
end

For Phoenix 1.3+, please use ~> 0.2.0

def deps do
  [{:ping_plug, "~> 0.2.0"}]
end

Usage

Mount PingPlug module to your desire route.

e.g. route.ex

get "/ping", PingPlug, []

Add :ping_plug to your application dependencies.

mix.exs

def application do
  [mod: {MyApp, []},
   applications: [..., :ping_plug, ...]]
end

Echo message can be specified by passing an optional params to PingPlug.

e.g.

get "/ping", PingPlug, [message: Mix.env]

Available options

  • :message, Echo message.
  • :content_type, Response content type.