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?

score 17 · Answer 1 · edited Jul 27 '23 at 00:19

17

For Rails 6 and below, you can directly write this in routes file

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

edited Jul 27 '23 at 00:19

Jason FB

4,752
3
38
69

answered Jan 19 '21 at 16:02

adityapandit17

356
1
8

oh yea that's super clean – Jason FB Jan 21 '21 at 20:35

score 2 · Answer 2 · answered Sep 25 '21 at 00:04

2

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à!

answered Sep 25 '21 at 00:04

linqueta

31
1

score 1 · Accepted Answer · answered Jul 25 '23 at 13:47

Rails 7 now provides a default health check controller.

We can now visit /up to check whether the app is running. If the application is healthy, it will return a 200 status code. Else, it will return a 503 status code (https://blog.saeloun.com/2023/02/27/rails-introduces-default-health-check-controller/#:~:text=With%20the%20latest%20changes%2C%20we,return%20a%20200%20status%20code)

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

3 Answers3