health_check 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 812ae12a10cfd6d24437f79dac7bd3b56ba46b01
-  data.tar.gz: a9df5e7810a0a165c56f69f6bf837ace4e2280cd
+SHA256:
+  metadata.gz: 5a8f9b5697e674eadaf79c49e68c55ef01c794a1fdb07c094026000aaa140296
+  data.tar.gz: 7598cfd30e1896ced703f44eee24a9c5f10110e9874c7461d9a7b014a704a686
 SHA512:
-  metadata.gz: 0da389e2581efa8883b27cea5dd76aa789caae942d11abccddd64455b7a03add304869b9e418e61f1a20206f6ed86eea4fa52ad74162c1e885724d0d984ba1d1
-  data.tar.gz: 4a726df067df79fe849dadf29e23d5794205de76c3b3fcd18756e354b711c650cc73c6d10a6121ac11adedf69aeaaacfe70c518377d3687ba4bfd6aff98cfec7
+  metadata.gz: 710941df9c976069d0a81cdd0f5e739bf82dd7b836c17d03c827b374988b729aa7f165101e87d1eef40a83312377338d8696a0e9b3a7961259babaee6e2a4925
+  data.tar.gz: 32b2cd9adde99918e95b9734a7ae8e096c7300c53c7385541f0e8fb31052ff3739d39858271f3deea316aed2925b2c3e5427bbc378ef8403392fa8a414bac05a

data/.gitignore

@@ -24,6 +24,8 @@ test/bin/
 railsapps/
 test/*.gemfile.lock
 ,*
+.vagrant
+ubuntu*console.log
 
 # See: https://gist.github.com/ianheggie/9327010
 # for Global git ignore for OS/IDE/temp/backup files

data/.travis.yml

@@ -1,4 +1,7 @@
-sudo: false
+dest: xenial
+os: linux
+# Released April 2018, Support ended: April 2023
+# ruby 2.4.9, 2.5.3, 2.5.7, 2.6.5 (default) and 2.7.0 pre-installed on travis
 addons:
   apt:
     packages:
@@ -23,9 +26,39 @@ bundler_args: "--binstubs"
 
 script: ./test/test_with_railsapp
 
-matrix:
+jobs:
   fast_finish: true
 
+  allow_failures:
+
+    - rvm: 3.0.1
+      gemfile: test/rails_6.1.gemfile
+      env:
+      - RAILS_VERSION=6.1
+      - MIDDLEWARE=YES
+
+    - rvm: 3.0.1
+      gemfile: test/rails_edge.gemfile
+      env: 
+      - RAILS_VERSION=edge 
+      - MIDDLEWARE=YES
+      - SMTP_STARTTLS=DISABLED
+
+    - rvm: ruby-head
+      gemfile: test/rails_6.1.gemfile
+      env: 
+      - RAILS_VERSION=6.1 
+      - MIDDLEWARE=YES
+      - SMTP_STARTTLS=DISABLED
+
+    - rvm: ruby-head
+      gemfile: test/rails_edge.gemfile
+      env: 
+      - RAILS_VERSION=edge 
+      - MIDDLEWARE=YES
+      - SMTP_STARTTLS=DISABLED
+
+
   include:
     # -------------------------------------
     # Standard
@@ -34,25 +67,40 @@ matrix:
     
     - rvm: 2.2.2
       gemfile: test/rails_5.0.gemfile
-      env: RAILS_VERSION=5.0 MIDDLEWARE=no
+      env: 
+      - RAILS_VERSION=5.0 
+      - MIDDLEWARE=no
+      - RUBYGEMS_VERSION=2.7.11
+      - BUNDLER_VERSION=1.17.3
 
     - rvm: 2.3.6
       gemfile: test/rails_5.0.gemfile
-      env: RAILS_VERSION=5.0 MIDDLEWARE=no
+      env:
+      - RAILS_VERSION=5.0
+      - MIDDLEWARE=no
 
     # rails 5.1 sometime before May 2017
     
     - rvm: 2.2.2
       gemfile: test/rails_5.1.gemfile
-      env: RAILS_VERSION=5.1 MIDDLEWARE=no
+      env:
+      - RAILS_VERSION=5.1
+      - MIDDLEWARE=no
+      - RUBYGEMS_VERSION=2.7.11
+      - BUNDLER_VERSION=1.17.3
 
     - rvm: 2.3.6
       gemfile: test/rails_5.1.gemfile
-      env: RAILS_VERSION=5.1 MIDDLEWARE=no
+      env:
+      - RAILS_VERSION=5.1
+      - MIDDLEWARE=no
+      - BUNDLER_VERSION=1.17.3
 
     - rvm: 2.4.3
       gemfile: test/rails_5.1.gemfile
-      env: RAILS_VERSION=5.1 MIDDLEWARE=no
+      env:
+      - RAILS_VERSION=5.1
+      - MIDDLEWARE=no
 
     # -------------------------------------
     # Middleware
@@ -61,19 +109,110 @@ matrix:
     
     - rvm: 2.2.2
       gemfile: test/rails_5.0.gemfile
-      env: RAILS_VERSION=5.0 MIDDLEWARE=yes
+      env:
+      - RAILS_VERSION=5.0
+      - MIDDLEWARE=yes
+      - RUBYGEMS_VERSION=2.7.11
+      - BUNDLER_VERSION=1.17.3
 
     - rvm: 2.3.6
       gemfile: test/rails_5.0.gemfile
-      env: RAILS_VERSION=5.0 MIDDLEWARE=yes
+      env:
+      - RAILS_VERSION=5.0
+      - MIDDLEWARE=yes
 
     # rails 5.1 sometime before May 2017
     
     - rvm: 2.2.2
       gemfile: test/rails_5.1.gemfile
-      env: RAILS_VERSION=5.1 MIDDLEWARE=yes
+      env:
+      - RAILS_VERSION=5.1
+      - MIDDLEWARE=yes
+      - RUBYGEMS_VERSION=2.7.11
+      - BUNDLER_VERSION=1.17.3
 
     - rvm: 2.4.3
       gemfile: test/rails_5.1.gemfile
-      env: RAILS_VERSION=5.1 MIDDLEWARE=yes
+      env:
+      - RAILS_VERSION=5.1
+      - MIDDLEWARE=yes
+
+
+    # rails 5.2 April 2018
+    # -------------------------------------
+    # INSTALLED AS MIDDLEWARE
+    
+
+    # rails 6.0
+
+    - rvm: 2.5.0
+      gemfile: test/rails_6.0.gemfile
+      env:
+      - RAILS_VERSION=6.0
+      - MIDDLEWARE=YES
+
+    - rvm: 2.6.7
+      gemfile: test/rails_6.0.gemfile
+      env:
+      - RAILS_VERSION=6.0
+      - MIDDLEWARE=YES
+    
+    # Not testing past recommended ruby version as listed on https://www.fastruby.io/blog/ruby/rails/versions/compatibility-table.html
+
+    # --------------------------------------
+    - rvm: 2.5.0
+      gemfile: test/rails_6.1.gemfile
+      env:
+      - RAILS_VERSION=6.1
+      - MIDDLEWARE=YES
+
+    - rvm: 2.6.6
+      gemfile: test/rails_6.1.gemfile
+      env:
+      - RAILS_VERSION=6.1
+      - MIDDLEWARE=YES
+
+    - rvm: 2.7.3
+      gemfile: test/rails_6.1.gemfile
+      env:
+      - RAILS_VERSION=6.1
+      - MIDDLEWARE=YES
+
+    - rvm: 3.0.1
+      gemfile: test/rails_6.1.gemfile
+      env:
+      - RAILS_VERSION=6.1
+      - MIDDLEWARE=YES
+      - SMTP_STARTTLS=DISABLED
+    
+   # ------------------
+   # FIXME
+   # ------------------
+
+    - rvm: 3.0.1
+      gemfile: test/rails_6.1.gemfile
+      env:
+      - RAILS_VERSION=6.1
+      - MIDDLEWARE=YES
+
+    - rvm: 3.0.1
+      gemfile: test/rails_edge.gemfile
+      env: 
+      - RAILS_VERSION=edge 
+      - MIDDLEWARE=YES
+      - SMTP_STARTTLS=DISABLED
+
+    - rvm: ruby-head
+      gemfile: test/rails_6.1.gemfile
+      env: 
+      - RAILS_VERSION=6.1 
+      - MIDDLEWARE=YES
+      - SMTP_STARTTLS=DISABLED
+
+    - rvm: ruby-head
+      gemfile: test/rails_edge.gemfile
+      env: 
+      - RAILS_VERSION=edge 
+      - MIDDLEWARE=YES
+      - SMTP_STARTTLS=DISABLED
 

data/CHANGELOG

@@ -1,5 +1,26 @@
 = Change Log =
 
+* 3.1.0 - 26 May 2021
+  * Updated README to clarify railsN branch status (they are intended to be stable, development to be a feature branch off them or master)
+  * Updated README with all the settings
+  * Updated all the branches to work with the latest travis and gem changes, as some gems needed to be locked down.
+  * Updated to test rails 6.0 and 6.1
+  * Got all travis tests passing
+  * Removed old, unused branches
+  * Merged PR Fix broken Cache-Control headers #93 from felixbuenemann 
+  * Merged PR S3 should not depend on Rails secrets file #77 by natefaerber
+  * Merged PR RabbitMQ Health check #98 from rhuanbarreto
+  * Merged PR Use remote_ip to accept proxy-forwarded requests #102 by alessio-signorini but made it optional
+  * Fixed up failure setting to match previous output on error, and use it as a prefix when the error message is also output (not by default)
+  * Always log the error to rails log even if not including in html response
+  * Merged PR ensure REDIS connections are closed #88 from yld
+  * Merged PR more robust cache check #90 from masciugo
+  * Merged PR Add log_level config setting which defaults to 'info'. #97 from FloHeinle 
+  * Merged PR get rid of old school hash rockets syntax #92 from DmytroStepaniuk
+  * Merged PR Converted whitelist testing to use IPAddr objects. #64 jordanyaker
+  * Added on_success and on_failure callbacks
+  * Makes sure errors are seperated by a period and a space and a period always ends the list of errors
+
 * 3.0.0
  * First release on rails5 branch
  * Depends on railties rather than rails so it can be used with trimmed down stacks

data/README.rdoc

@@ -1,11 +1,19 @@
 = health_check gem
 
-Simple health check of Rails 5.x apps for use with Pingdom, NewRelic, EngineYard or uptime.openacs.org etc.
+Simple health check of Rails 5.x and 6.x apps for use with Pingdom, NewRelic, EngineYard etc.
 
 The basic goal is to quickly check that rails is up and running and that it has access to correctly configured resources (database, email gateway)
 
 Check the latest README {master}[https://github.com/ianheggie/health_check/tree/master] for other versions
 
+Use gem versions for stable releases:
+* ~> 3.x for Rails 5.x and 6.x (etc until there is a proven need to split off another branch),
+* ~> 2.x for Rails 4.x,
+* ~> 1.7 for Rails 3.x,
+* ~> 1.6.3 for Rails 2.3
+
+Note: it is best to pin to a specific commit if using a development branch as sometimes tests break.
+
 health_check provides various monitoring URIs, for example:
 
     curl localhost:3000/health_check
@@ -24,6 +32,7 @@ health_check provides various monitoring URIs, for example:
 You may also issue POST calls instead of GET to these urls.
 
 On failure (detected by health_check) a 500 http status is returned with a simple explanation of the failure
+(if include_error_in_response_body is true)
 
     curl localhost:3000/health_check/fail
     health_check failed: invalid argument to health_test.
@@ -39,10 +48,12 @@ The health_check controller disables sessions for versions that eagerly load ses
 * database - checks that the current migration level can be read from the database
 * email - basic check of email - :test returns true, :sendmail checks file is present and executable, :smtp sends HELO command to server and checks response
 * migration - checks that the database migration level matches that in db/migrations
+* rabbitmq - RabbitMQ Health Check
 * redis / redis-if-present - checks Redis connectivity
 * resque-redis / resque-redis-if-present - checks Resque connectivity to Redis
 * s3 / s3-if-present - checks proper permissions to s3 buckets
 * sidekiq-redis / sidekiq-redis-if-present - checks Sidekiq connectivity to Redis
+* elasticsearch / elasticsearch-if-present - checks Elasticsearch connectivity
 * site - checks rails is running sufficiently to render text
 
 Some checks have a *-if-present form, which only runs the check if the corresponding library has been required.
@@ -55,9 +66,9 @@ Note: rails also checks migrations by default in development mode and throws an
 
 == Installation
 
-Add the following line to Gemfile
+Add the following line to Gemfile (after the rails gems are listed)
 
-    gem "health_check"
+    gem 'health_check'
 
 And then execute
 
@@ -79,6 +90,16 @@ To change the configuration of health_check, create a file `config/initializers/
       # Text output upon success
       config.success = 'success'
 
+      # Text output upon failure
+      config.failure = 'health_check failed'
+
+      # Disable the error message to prevent /health_check from leaking
+      # sensitive information
+      config.include_error_in_response_body = false
+
+      # Log level (success or failure message with error details is sent to rails log unless this is set to nil)
+      config.log_level = 'info'
+
       # Timeout in seconds used when checking smtp server
       config.smtp_timeout = 30.0
 
@@ -89,7 +110,7 @@ To change the configuration of health_check, create a file `config/initializers/
       config.http_status_for_error_text = 500
 
       # http status code used when an error object is output (json or xml)
-      # Set to 200 if you want your want to distinguish between partial (healthy property == false) and
+      # Set to 200 if you want to distinguish between partial (healthy property == false) and
       # total failure of rails application (http status of 500 etc)
 
       config.http_status_for_error_object = 500
@@ -129,15 +150,37 @@ To change the configuration of health_check, create a file `config/initializers/
       config.basic_auth_username = 'my_username'
       config.basic_auth_password = 'my_password'
 
-      # Whitelist requesting IPs
-      # Defaults to blank and allows any IP
-      config.origin_ip_whitelist = %w(123.123.123.123)
+      # Whitelist requesting IPs by a list of IP and/or CIDR ranges, either IPv4 or IPv6 (uses IPAddr.include? method to check)
+      # Defaults to blank which allows any IP
+      config.origin_ip_whitelist = %w(123.123.123.123 10.11.12.0/24 2400:cb00::/32)
+
+      # Use ActionDispatch::Request's remote_ip method when behind a proxy to pick up the real remote IP for origin_ip_whitelist check
+      # Otherwise uses Rack::Request's ip method (the default, and always used by Middleware), which is more susceptable to spoofing
+      # See https://stackoverflow.com/questions/10997005/whats-the-difference-between-request-remote-ip-and-request-ip-in-rails
+      config.accept_proxied_requests = false
 
       # http status code used when the ip is not allowed for the request
       config.http_status_for_ip_whitelist_error = 403
 
-      # When redis url is non-standard
-      config.redis_url = 'redis_url'
+      # rabbitmq
+      config.rabbitmq_config = {}
+
+      # When redis url/password is non-standard
+      config.redis_url = 'redis_url' # default ENV['REDIS_URL']
+      # Only included if set, as url can optionally include passwords as well
+      config.redis_password = 'redis_password' # default ENV['REDIS_PASSWORD']
+
+      # Failure Hooks to do something more ...
+      # checks lists the checks requested
+      config.on_failure do |checks, msg|
+        # log msg somewhere
+      end
+    
+      config.on_success do |checks|
+        # flag that everything is well
+      end
+  
+
     end
 
 You may call add_custom_check multiple times with different tests. These tests will be included in the default list ("standard").
@@ -151,7 +194,7 @@ Install health_check as middleware if you want to sometimes ignore exceptions fr
 eg DB connection errors from QueryCache. The "middleware" check will fail if you have not installed health_check as middleware.
 
 To install health_check as middleware add the following line to the config/application.rb:
-    config.middleware.insert_after "Rails::Rack::Logger", HealthCheck::MiddlewareHealthcheck
+    config.middleware.insert_after Rails::Rack::Logger, HealthCheck::MiddlewareHealthcheck
 
 Note: health_check is installed as a full rails engine even if it has been installed as middleware. This is so the
 remaining checks continue to run through the complete rails stack.
@@ -174,7 +217,6 @@ See
 
 * Pingdom Website Monitoring - https://www.pingdom.com
 * NewRelic Availability Monitoring - http://newrelic.com/docs/features/availability-monitoring-faq
-* Uptime by OpenACS - http://uptime.openacs.org/uptime/
 * Engine Yard's guide - https://support.cloud.engineyard.com/entries/20996821-monitor-application-uptime (although the guide is based on fitter_happier plugin it will also work with this gem)
 * Nagios check_http (with -s success) - https://www.nagios-plugins.org/doc/man/check_http.html
 * Any other montoring service that can be set to check for the word success in the text returned from a url
@@ -236,24 +278,31 @@ Last-modified is set to the current time (rounded down to a multiple of max_age
 
 == Known Issues
 
+* See https://github.com/ianheggie/health_check/issues
 * No inline documentation for methods
 * <b>rvm gemsets breaks the test</b> - specifically <tt>rvm use 1.9.3</tt> works but <tt>rvm gemset use ruby-1.9.3-p385@health_check --create</tt> triggers a "Could not find gem 'coffee-rails (~> 3.2.1) ruby' in the gems available on this machine." error in the last call to bundle (installing health_check as a gem via a path into the temp railsapp)
 
 == Similar projects
 
 * fitter_happier plugin by atmos - plugin with similar goals, but not compatible with uptime, and does not check email gateway
+* HealthBit - inspired by this gem but with a fresh start as a simpler rack only application, no travis CI tests (yet?) but looks interesting.
 
 == Testing
 
 === Automated testing and other checks
 
-* {<img src="https://travis-ci.org/ianheggie/health_check.svg?branch=rails5">}[https://travis-ci.org/ianheggie/health_check.svg?branch=rails5]  - Travis CI 
+* {<img src="https://badge.fury.io/rb/health_check.svg" alt="Gem Version" />}[http://badge.fury.io/rb/health_check] - Latest Gem
+* {<img src="https://travis-ci.org/ianheggie/health_check.svg">}[https://travis-ci.org/ianheggie/health_check]  - Travis CI
+* {<img src="https://codeclimate.com/github/ianheggie/health_check.svg" />}[https://codeclimate.com/github/ianheggie/health_check] - Code quality
+* {<img src="https://gemnasium.com/ianheggie/health_check.svg">}[https://gemnasium.com/ianheggie/health_check] - Gem dependencies
 
 === Manual testing
 
-The instructions have been changed to using a vagrant virtual box for consistant results.
+The instructions have been changed to using a vagrant virtual box for consistent results.
+
+Install vagrant 1.9.7 or later and virtual_box or other local virtual machine provider.  Add the vagrant plugin called vbguest.
 
-Install vagrant 1.9.7 or later and virtual_box or other local virtual machine providor.
+    vagrant plugin install vagrant-vbguest
 
 Create a temp directory for throw away testing, and clone the health_check gem into it
 
@@ -281,11 +330,11 @@ Cd to the checked out health_check directory and then run the test as follows:
 
     cd /vagrant  # the current directory on your host is mounted here on the virtual machine
 
-    chruby 2.2.2 # or some other ruby version 
+    chruby 2.2.2 # or some other ruby version (run chruby with no arguments to see the current list)
 
     test/test_with_railsapp
 
-    exit        # from viretual machine when finished
+    exit        # from virtual machine when finished
 
 The script will first call `test/setup_railsapp` to setup a rails app with health_check installed and then
 run up the rails server and perform veraious tests.
@@ -297,7 +346,7 @@ The command `rake test` will also launch these tests, except it cannot install t
 
 == Copyright
 
-Copyright (c) 2010-2017 Ian Heggie, released under the MIT license.
+Copyright (c) 2010-2021 Ian Heggie, released under the MIT license.
 See MIT-LICENSE for details.
 
 == Contributors
@@ -306,10 +355,18 @@ Thanks go to the various people who have given feedback and suggestions via the
 
 === Contributing
 
+Use gem versions for stable releases, or github branch / commits for development versions:
+* for Rails 5.x and 6.x use feature branched off master {master}[https://github.com/ianheggie/health_check/tree/master] for development;
+* for Rails 4.x use feature branches off the {rails4}[https://github.com/ianheggie/health_check/tree/rails4] stable branch for development;
+* for Rails 3.x use feature branches off the {rails3}[https://github.com/ianheggie/health_check/tree/rails3] stable branch for development;
+* for Rails 2.3 use feature branches off the {rails2.3}[https://github.com/ianheggie/health_check/tree/rails2.3] stable branch for development;
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request (Code with BDD tests are favoured)
+3. Create a test that confirms your changes work
+4. Update README.rdoc to explain enhancements, or add succinct comment in code when fixing bugs
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request (Code with BDD tests and documentation are highly favoured)
 
-<em>Feedback welcome! Especially with suggested replacement code and corresponding tests</em>
+<em>Feedback welcome! Especially with suggested replacement code, tests and documentation</em>