Add healthcheck endpoint for web (#11770)

diff --git a/Gemfile b/Gemfile
index 1cbf23cf21d838121649d78f1ed04b3a78bffe1b..d9740702fe8b4690dc283db64b2d46f1f990f6ae 100644 (file)
--- a/Gemfile
+++ b/Gemfile
@@ -50,6 +50,7 @@ gem 'fastimage'
 gem 'goldfinger', '~> 2.1'
 gem 'hiredis', '~> 0.6'
 gem 'redis-namespace', '~> 1.5'
+gem 'health_check', '~> 3.0'
 gem 'htmlentities', '~> 4.3'
 gem 'http', '~> 3.3'
 gem 'http_accept_language', '~> 2.1'

diff --git a/Gemfile.lock b/Gemfile.lock
index 8ecc8ebb75526f2709f29a91432968a38fb1cf24..b0f6bf083fbbf8e4180b470e3e25348573ddda06 100644 (file)
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -278,6 +278,8 @@ GEM
       concurrent-ruby (~> 1.0)
     hashdiff (1.0.0)
     hashie (3.6.0)
+    health_check (3.0.0)
+      railties (>= 5.0)
     heapy (0.1.4)
     highline (2.0.1)
     hiredis (0.6.3)
@@ -706,6 +708,7 @@ DEPENDENCIES
   fuubar (~> 2.4)
   goldfinger (~> 2.1)
   hamlit-rails (~> 0.2)
+  health_check (~> 3.0)
   hiredis (~> 0.6)
   htmlentities (~> 4.3)
   http (~> 3.3)

diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
index 5b343a276fbd723a46f01cdb5fa56cffe95f02e6..bd3d137743f89339f8d7629a634a093435094c8e 100644 (file)
--- a/app/controllers/application_controller.rb
+++ b/app/controllers/application_controller.rb
@@ -41,7 +41,7 @@ class ApplicationController < ActionController::Base
   private
 
   def https_enabled?
-    Rails.env.production?
+    Rails.env.production? && !request.path.start_with?('/health')
   end
 
   def authorized_fetch_mode?

diff --git a/config/initializers/health_check.rb b/config/initializers/health_check.rb
new file mode 100644 (file)
index 0000000..eece67b
--- /dev/null
+++ b/config/initializers/health_check.rb
@@ -0,0 +1,6 @@
+HealthCheck.setup do |config|
+  config.uri = 'health'
+
+  config.standard_checks = %w(database migrations cache)
+  config.full_checks = %w(database migrations cache)
+end

diff --git a/config/routes.rb b/config/routes.rb
index 74a162f327b16905000bfb12d0d2e7ac017f618e..fe8425341a450a344cbbe8c0e0395d9b7601ede0 100644 (file)
--- a/config/routes.rb
+++ b/config/routes.rb
@@ -10,6 +10,8 @@ Rails.application.routes.draw do
 
   mount LetterOpenerWeb::Engine, at: 'letter_opener' if Rails.env.development?
 
+  health_check_routes
+
   authenticate :user, lambda { |u| u.admin? } do
     mount Sidekiq::Web, at: 'sidekiq', as: :sidekiq
     mount PgHero::Engine, at: 'pghero', as: :pghero

diff --git a/docker-compose.yml b/docker-compose.yml
index 7406849663e61280d44fcbfda16176692eaaee65..20649e4245c06749c836d7cdef36baaecfa424d2 100644 (file)
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -43,7 +43,7 @@ services:
       - external_network
       - internal_network
     healthcheck:
-      test: ["CMD-SHELL", "wget -q --spider --header 'x-forwarded-proto: https' --proxy=off localhost:3000/api/v1/instance || exit 1"]
+      test: ["CMD-SHELL", "wget -q --spider --proxy=off localhost:3000/health || exit 1"]
     ports:
       - "127.0.0.1:3000:3000"
     depends_on:
@@ -63,7 +63,7 @@ services:
       - external_network
       - internal_network
     healthcheck:
-      test: ["CMD-SHELL", "wget -q --spider --header 'x-forwarded-proto: https' --proxy=off localhost:4000/api/v1/streaming/health || exit 1"]
+      test: ["CMD-SHELL", "wget -q --spider --proxy=off localhost:4000/api/v1/streaming/health || exit 1"]
     ports:
       - "127.0.0.1:4000:4000"
     depends_on: