How can I do a health check for a Rails-based app on Render?

Question

Render requires a /health endpoint, but when I create this in my app & deploy for the first time, I am unable to deploy because the app cannot boot without the migrations having run first.

it seems that Render.com health check needs the health endpoint to respond OK even before the migrations have run. how can I achieve this?

user_10221229 · Answer

You can directly write this in routes file

get '/health_check', to: proc { [200, {}, ['success']] }

It will work for you

user_3163663 · Answer

create file lib/health_check.rb

HealthCheck = Rack::Builder.new do
  use Rack::CommonLogger
  map '/' do
    run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['OK']] }
  end
end

create file config/initializers/health_check.rb

require './lib/health_check.rb'

Then, in your routes.rb file,

  mount HealthCheck, at: "/health"

user_13316861 · Answer

You can use rails-healthcheck (https://github.com/linqueta/rails-healthcheck) gem to it simple:

Install the gem and run the generator rails g healthcheck:install and call /healthcheck and voilà!

How can I do a health check for a Rails-based app on Render?

3 Answers