deep_health_check 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 837e823c90a18054f24eeb42e3079edfaed7de08d103dc66c476e5f31d237640
+  data.tar.gz: 94b9be499506937b5728f7f24863a7fec3ecad6ef0dcf892fca13098cd2d3af7
+SHA512:
+  metadata.gz: 1774e274f3cb5a3843629d446cd3e462d063ed9419ac0c904d1261006c4095c3338a7a08fbed249ace233270722528f6871aef8865417e31701ce8eba1e4467d
+  data.tar.gz: 9a7496f4e793c9b2a6a127b0276154ea14f24171c5857780f8109f00e5c56f9f1a152bce7063cc543bc8e5690bb477f4f5ebadccdb40ced497309a703f0841a0

data/.github/workflows/gempush.yml

@@ -0,0 +1,38 @@
+name: Ruby Gem
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}
+
+    - name: Slack notification Success
+      if: success()
+      env:
+        SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+      uses: cemkiy/action-slacker@master
+      with:
+        channel: '#github-ci-actions'
+        icon_url: 'https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png'
+        username: 'GitHub'

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  Exclude:
+    - 'bin/*'
+Documentation:
+    Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'

data/.ruby-gemset

@@ -0,0 +1 @@
+deep_health_check

data/.ruby-version

@@ -0,0 +1 @@
+2.4.6

data/.travis.yml

@@ -0,0 +1,18 @@
+sudo: false
+
+language: ruby
+
+rvm:
+  - 2.6.4
+
+bundler_args: --without system_tests
+
+script: bin/travis
+
+matrix:
+  fast_finish: true
+
+env:
+  matrix:
+    - BUILD_TYPE=rspec
+    - BUILD_TYPE=rubocop

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in health_check.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Al-waleed shihadeh
+
+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/NGINX.md

@@ -0,0 +1,44 @@
+# Protect Health Check endpoints using htauth credentials.
+
+## Create htpasswd file
+  - Create /etc/nginx/.htpasswd. The format for this file is as follow:
+
+    ```
+    $user:password
+    ```
+
+  - The password can be generated using the following command.
+
+    ```
+    $-> openssl passwd -apr1
+    ```
+
+  - Example of the file.
+
+    ```
+    httpauth:$apr1$LNrZDUUO$sAN3WLCm7YN6gzGjnCc85.
+    ```
+
+  - In case you are using dockerized nginx, Update the docker file with the following command.
+
+    ```
+    COPY ${path_to_htpasswd_file} /etc/nginx/.htpasswd
+    ```
+
+## Update the nginx configurations
+Add the following lines to nginx confutations for each of the applications that use the health check gem. Make sure that you replace the place holders #{application} and #{port}.
+
+```
+location /${endpoint_to_be_protected} {
+    auth_basic "Restricted Content";
+    auth_basic_user_file /etc/nginx/.htpasswd;
+
+    resolver 127.0.0.11 ipv6=off;
+
+    set $target http://#{application}:#{port};
+    proxy_set_header Host $host;
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_pass $target;
+  }
+```

data/README.md

@@ -0,0 +1,33 @@
+# HealthCheck
+
+A simple Health status API
+
+# Getting Started
+
+Install gem
+~~~sh
+ # Gemfile
+ gem 'deep_health_check'
+~~~
+
+Add middleware before Rails::Rack::Logger to prevent false positive response
+if other middleware fails when database is down for example ActiveRecord::QueryCache
+
+~~~sh
+ # config/application.rb
+ config.middleware.insert_after "Rails::Rack::Logger", DeepHealthCheck::MiddlewareHealthCheck
+~~~
+
+
+
+
+# Protect Health Check endpoints using htauth credentials.
+Health check middleware expose the following endpoints
+  - /health
+  - /db_health
+  - /tcp_dependencies_health
+  - /http_dependencies_health
+
+Some of these endpoints provide information about the database and system status. By Default these endpoints are not protected and are accessible publicly. To reduce the security risk introduced by exposing these endpoints, We can protect them using htauth credentials. The following page provide all the necessary steps needed to achieve this task.
+
+[Nginx Configurations](NGINX.md)

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec)

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'deep_health_check'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/travis

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+set -e
+
+case "$BUILD_TYPE" in
+  "rubocop")
+    bundle exec rubocop
+    ;;
+   "rspec")
+   bundle exec rspec
+   ;;
+esac

data/deep_health_check.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deep_health_check/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'deep_health_check'
+  spec.version       = DeepHealthCheck::VERSION
+  spec.authors       = ['Al-waleed shihadeh']
+  spec.email         = ['shihadeh.dev@gmail.com']
+
+  spec.summary       = 'Provides a health check API endpoint'
+  spec.description   = 'Provides a health check API endpoint'
+  spec.homepage      = 'https://github.com/wshihadeh/deep_health_check'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'net-telnet'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rack-test', '~> 1.1.0'
+  spec.add_development_dependency 'rspec', '~> 3.5.0'
+  spec.add_development_dependency 'rubocop', '0.78.0'
+end

data/lib/deep_health_check.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'deep_health_check/version'
+require 'deep_health_check/health_check'
+require 'deep_health_check/db_health_check'
+require 'deep_health_check/dependency_health_check'
+require 'deep_health_check/tcp_dependency_health_check'
+require 'deep_health_check/http_dependency_health_check'
+require 'deep_health_check/health_check_builder'
+require 'deep_health_check/middleware_health_check'
+
+module DeepHealthCheck
+end

data/lib/deep_health_check/db_health_check.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module DeepHealthCheck
+  class DBHealthCheck < HealthCheck
+    def call
+      respose(db_active_record.merge(db_delayed_jobs))
+    end
+
+    private
+
+    def respose(data)
+      api_health_check 200, "connected": data[:connected],
+                            "tables": data[:tables].to_s,
+                            "max_connection_size": data[:db_size].to_s,
+                            "open_connection": data[:db_conn_size].to_s,
+                            "dj_total_count": data[:dj_count].to_s,
+                            "dj_faild_count": data[:faild_dj_count].to_s,
+                            "dj_terminated_count": data[:terminated_count].to_s
+    end
+
+    def db_active_record
+      data = {}
+      data[:tables] = ActiveRecord::Base.connection.tables.count
+      data[:connected] = ActiveRecord::Base.connected?
+      data[:db_size] = ActiveRecord::Base.connection_pool.size
+      data[:db_conn_size] = ActiveRecord::Base.connection_pool.connections.size
+      data
+    rescue
+      {}
+    end
+
+    def db_delayed_jobs
+      data = {}
+      data[:dj_count] = Delayed::Job.count
+      data[:terminated_count] = Delayed::Job.where.not(failed_at: nil).count
+      data[:faild_dj_count] = Delayed::Job.where(failed_at: nil)
+                                          .where('attempts > 0').count
+    rescue
+      {}
+    end
+  end
+end

data/lib/deep_health_check/dependency_health_check.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module DeepHealthCheck
+  class DependencyHealthCheck < HealthCheck
+    def initialize
+      @type = 'abstract'
+      @dependencies = nil
+      raise 'You are trying to instantiate an abstract class!'
+    end
+
+    def call
+      return no_dependencies_response if @dependencies.nil?
+      api_health_check health_status_code, @dependencies
+    end
+
+    private
+
+    def health_status_code
+      raise 'health_status_code need to implmented'
+    end
+
+    def no_dependencies_response
+      api_health_check 200, 'message': "No #{@type.upcase} dependencies defined"
+    end
+
+    def fetch_dependencies_from_env
+      dependencies = []
+      (0..99).each do |i|
+        dependencies << ENV[format("#{@type.upcase}_DEPENDENCY_%02d", i)]
+      end
+      dependencies.compact
+    end
+  end
+end

data/lib/deep_health_check/health_check.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DeepHealthCheck
+  class HealthCheck
+    def call
+      api_health_check 200, 'message': 'OK'
+    end
+
+    private
+
+    def api_health_check(status, payload)
+      [status,
+       { 'Content-Type' => 'application/json' },
+       [{
+         'data': {
+           'type': 'checker',
+           'id': '1',
+           'attributes': payload
+         }
+       }.to_json]]
+    end
+  end
+end

data/lib/deep_health_check/health_check_builder.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module DeepHealthCheck
+  class HealthCheckBuilder
+    def self.build(check)
+      case check
+      when '/health'
+        HealthCheck.new
+      when '/db_health'
+        DBHealthCheck.new
+      when '/tcp_dependencies_health'
+        TCPDependencyHealthCheck.new
+      when '/http_dependencies_health'
+        HTTPDependencyHealthCheck.new
+      end
+    end
+  end
+end

data/lib/deep_health_check/http_dependency_health_check.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+
+module DeepHealthCheck
+  class HTTPDependencyHealthCheck < DependencyHealthCheck
+    def initialize
+      @type = 'http'
+      @dependencies = process_dependencies fetch_dependencies_from_env
+    end
+
+    private
+
+    def process_dependencies(dependencies_list)
+      threads = dependencies_list.map do |url|
+        Thread.new do
+          { url.to_s => http_status(url) }
+        end
+      end
+
+      threads.each(&:join)
+      threads.map(&:value).reduce(&:merge)
+    end
+
+    def health_status_code
+      failed = @dependencies.any? do |_name, response|
+        !response[:status] || response[:status] >= 300
+      end
+      failed ? 503 : 200
+    end
+
+    def http_status(url)
+      response = faraday.get url
+      { status: response.status, details: response.body }
+    rescue RuntimeError, Faraday::Error => e
+      { status: nil, details: e.inspect }
+    end
+
+    def faraday
+      Faraday.new do |builder|
+        builder.response :json, content_type: /\bjson$/
+        builder.response(:encoding) if defined?(Faraday::Encoding)
+        builder.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/deep_health_check/middleware_health_check.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DeepHealthCheck
+  class MiddlewareHealthCheck
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      health_check = HealthCheckBuilder.build env['PATH_INFO']
+      health_check&.call || @app.call(env)
+    end
+  end
+end

data/lib/deep_health_check/tcp_dependency_health_check.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'net-telnet'
+
+module DeepHealthCheck
+  class TCPDependencyHealthCheck < DependencyHealthCheck
+    def initialize
+      @type = 'tcp'
+      @dependencies = process_dependencies fetch_dependencies_from_env
+    end
+
+    private
+
+    def process_dependencies(dependencies_list)
+      threads = dependencies_list.map do |item|
+        host, port = item.to_s.split(':')
+        Thread.new do
+          { "#{host}_#{port}" => tcp_telnet_status(host, port) }
+        end
+      end
+
+      threads.each(&:join)
+      threads.map(&:value).reduce(&:merge)
+    end
+
+    def health_status_code
+      faild_count = @dependencies.select { |_k, v| v == down }.count
+      faild_count.zero? ? 200 : 503
+    end
+
+    def tcp_telnet_status(host, port)
+      return up if Net::Telnet.new(
+        'Host' => host,
+        'Port' => port,
+        'Telnetmode' => false,
+        'Prompt' => /^\+OK/n
+      )
+      down
+    rescue
+      down
+    end
+
+    def up
+      { 'message': 'UP' }
+    end
+
+    def down
+      { 'message': 'DOWN' }
+    end
+  end
+end

data/lib/deep_health_check/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DeepHealthCheck
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: deep_health_check
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Al-waleed shihadeh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-telnet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.78.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.78.0
+description: Provides a health check API endpoint
+email:
+- shihadeh.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gempush.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- NGINX.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/travis
+- deep_health_check.gemspec
+- lib/deep_health_check.rb
+- lib/deep_health_check/db_health_check.rb
+- lib/deep_health_check/dependency_health_check.rb
+- lib/deep_health_check/health_check.rb
+- lib/deep_health_check/health_check_builder.rb
+- lib/deep_health_check/http_dependency_health_check.rb
+- lib/deep_health_check/middleware_health_check.rb
+- lib/deep_health_check/tcp_dependency_health_check.rb
+- lib/deep_health_check/version.rb
+homepage: https://github.com/wshihadeh/deep_health_check
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Provides a health check API endpoint
+test_files: []