health_monitor_lb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f5c7c695382a747e409feb32c8140500f0481be76d2c6a3d734faa12e328682e
+  data.tar.gz: '086859234d7b215306081c53d48fdfb54cf940f5d75b05a18bbed8c5cde99186'
+SHA512:
+  metadata.gz: b8a0d67c9e4059adbb8805ec7a9b8f8bd0ee70c7436dfb55425d7bef55657c9c84733c94993143a7762a7e15cd4cc4c844c2c12235ffb0d0004f10c49b3656ae
+  data.tar.gz: 32a1358c803e76eb469eb8b001506613571d2073e648eedcff21bae1ddf280c8fd697a672caaf9e3ef906ebc14caf08554766e94673144eea53c450e97edb813

data/README.md

@@ -0,0 +1,78 @@
+# HealthMonitor
+Add a health check endpoint for AWS Load Balancer monitoring
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'health_monitor'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install health_monitor
+```
+
+## Usage
+Add the Rails engine included in the gem to your routes by adding
+
+```ruby
+mount HealthMonitor::Engine, at: '/'
+```
+
+to config/routes.rb
+
+Set the environment variable `HEALTH_MONITOR_API_TOKEN` to add a token which helps prevent denial of service attacks. Set the query parameter `API_TOKEN` with the token value when making an HTTP request. For example:
+
+```http
+https://myapp.com/health?API_TOKEN=12344321
+```
+
+### Custom Health Checks
+The base checks test Postgres, Redis, and the Ruby interpreter as well as listing the Rails version. Additional health checks can be added. Each customer health check needs to be a class with a static method called `health_check`. For example:
+
+```ruby
+class TestHealthCheck
+  def self.health_check
+    { test_health_check: 'ok' }
+  end
+end
+```
+
+The class name needs to be added to the list of additional checks during setup (typically in an initializer file):
+
+```ruby
+HealthMonitor.setup do |config|
+  config.additional_health_checks = ['TestHealthCheck']
+end
+```
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2009 Jonas Nicklas
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/health_monitor/application_controller.rb

@@ -0,0 +1,11 @@
+module HealthMonitor
+  class ApplicationController < ActionController::API
+    before_action :check_api_token
+
+    def check_api_token
+      if ENV['HEALTH_MONITOR_API_TOKEN'].present? && (params['API_TOKEN'] != ENV['HEALTH_MONITOR_API_TOKEN'])
+        render json: 'unauthorized', status: :unauthorized
+      end
+    end
+  end
+end

data/app/controllers/health_monitor/health_controller.rb

@@ -0,0 +1,13 @@
+module HealthMonitor
+  class HealthController < ApplicationController
+    def index
+      status = HealthCheckService.new.call
+
+      response.set_header('Cache-Control', 'no-cache, no-store, must-revalidate')
+      response.set_header('Pragma', 'no-cache')
+      response.set_header('Expires', '0')
+
+      render json: status, status: :ok
+    end
+  end
+end

data/app/services/health_monitor/health_check_service.rb

@@ -0,0 +1,40 @@
+module HealthMonitor
+  class HealthCheckService
+    def call
+      status = { rails_version: Rails::VERSION::STRING }
+               .merge(ruby_check)
+               .merge(postgres_check)
+               .merge(redis_check)
+
+      HealthMonitor.additional_health_checks.each do |health_check_klass|
+        status = status.merge(health_check_klass.safe_constantize.health_check)
+      end
+
+      status
+    end
+
+    def ruby_check
+      status = "2\n" == `ruby -e 'puts 1 + 1'` ? 'ok' : 'down'
+
+      { ruby: status }
+    end
+
+    def postgres_check
+      return {} if ENV['DATABASE_URL'].blank?
+
+      pg_conn = PG::Connection.open(ENV['DATABASE_URL'])
+      status = pg_conn.connect_poll ? 'ok' : 'down'
+
+      { db: status }
+    end
+
+    def redis_check
+      return {} if ENV['REDIS_URL'].blank?
+
+      redis = Redis.new(url: ENV['REDIS_URL'], ssl_params: { verify_mode: OpenSSL::SSL::VERIFY_NONE })
+      status = redis.ping == 'PONG' ? 'ok' : 'down'
+
+      { redis: status }
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/health_monitor/engine', __dir__)
+APP_PATH = File.expand_path('../spec/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails/all"
+require "rails/engine/commands"

data/config/routes.rb

@@ -0,0 +1,3 @@
+HealthMonitor::Engine.routes.draw do
+  get '/health' => 'health#index'
+end

data/lib/health_monitor/engine.rb

@@ -0,0 +1,5 @@
+module HealthMonitor
+  class Engine < ::Rails::Engine
+    isolate_namespace HealthMonitor
+  end
+end

data/lib/health_monitor/version.rb

@@ -0,0 +1,3 @@
+module HealthMonitor
+  VERSION = '1.0.0'.freeze
+end

data/lib/health_monitor.rb

@@ -0,0 +1,11 @@
+require "health_monitor/version"
+require "health_monitor/engine"
+
+module HealthMonitor
+  mattr_accessor :additional_health_checks
+  @@additional_health_checks = []
+
+  def self.setup
+    yield self
+  end
+end

data/lib/tasks/health_monitor_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :health_monitor do
+#   # Task goes here
+# end

data/spec/controllers/health_monitor/health_controller_spec.rb

@@ -0,0 +1,40 @@
+require 'rails_helper'
+
+module HealthControllerSpec
+  class TestHealthCheck
+    def self.health_check
+      { 'test_health_check' => 'ok' }
+    end
+  end
+end
+
+describe HealthMonitor::HealthController, type: :controller do
+  routes { HealthMonitor::Engine.routes }
+
+  context 'not authorized' do
+    it 'returns unauthorized without a token' do
+      get :index
+      expect(response.status).to eq(401)
+    end
+  end
+
+  context 'authorized' do
+    it 'returns ok with a token' do
+      get :index, params: { API_TOKEN: ENV['HEALTH_MONITOR_API_TOKEN'] }
+      expect(response.status).to eq(200)
+
+      expect(response.parsed_body).to include({ 'rails_version' => Rails::VERSION::STRING, 'ruby' => 'ok' })
+    end
+
+    it 'handles custom checks' do
+      HealthMonitor.additional_health_checks = ['HealthControllerSpec::TestHealthCheck']
+
+      get :index, params: { API_TOKEN: ENV['HEALTH_MONITOR_API_TOKEN'] }
+      expect(response.status).to eq(200)
+
+      expect(response.parsed_body).to include({ 'rails_version' => Rails::VERSION::STRING, 'ruby' => 'ok', 'test_health_check' => 'ok' })
+
+      HealthMonitor.additional_health_checks = []
+    end
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css
+//= link health_monitor_manifest.js

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/javascript/packs/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag 'application', media: 'all' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:prepare'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,22 @@
+require_relative "boot"
+
+require "rails/all"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+require "health_monitor"
+
+module Dummy
+  class Application < Rails::Application
+    config.load_defaults Rails::VERSION::STRING.to_f
+
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/dummy/config/cable.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+
+test:
+  adapter: test
+
+production:
+  adapter: redis
+  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  channel_prefix: dummy_production

data/spec/dummy/config/database.yml

@@ -0,0 +1,2 @@
+test:
+  adapter: nulldb

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative "application"
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,76 @@
+require "active_support/core_ext/integer/time"
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded any time
+  # it changes. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  # Run rails dev:cache to toggle caching.
+  if Rails.root.join('tmp', 'caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
+    config.action_controller.enable_fragment_cache_logging = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => "public, max-age=#{2.days.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Store uploaded files on the local file system (see config/storage.yml for options).
+  config.active_storage.service = :local
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Highlight code that triggered database queries in logs.
+  config.active_record.verbose_query_logs = true
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+
+  # Uncomment if you wish to allow Action Cable access from any origin.
+  # config.action_cable.disable_request_forgery_protection = true
+end