okcomputer 1.18.6 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b6e5540ab36865e49a7a6986c35dead38e31d4b20838a5818425cf3069c7129
-  data.tar.gz: 95c4133f1277ed3042bc41d33905aafc4ba774b50fb49a94b2202b7000aa81db
+  metadata.gz: 834e3e304e55f2824d48769656b7fbfda10219d176d23fc445adfeaef01aaca8
+  data.tar.gz: 958d4a30a4a391f31734713f56dea8b492b7952b53bb7f339aa168a8e37d133f
 SHA512:
-  metadata.gz: 4abc303ee824b255cd9f087b109b9420a1e06dbc2f5fcd35d11dd6c4ebb3538ac6c79f08d2fd7e04ff4209e6bb8741f53986680ea3578a70ddc18562b0a16015
-  data.tar.gz: 48bb60d5dcded343a640272958eba7ebb38cb2a519b084969979e3a9ea8df680dfdbe2591640a8fd5577918cad20e9712db86e88e764da2b30472edff56a4827
+  metadata.gz: 64d45f7f723099e15f7fc54e305029c6893a16e81fdd1ac353343d0be1b8f3ee7a33c412591dd343c6ddc84c9495ae85bb79ad742804019ba0e627e8dffddae0
+  data.tar.gz: 92429b914eff4069011dfd05aeba9b4ab725816b1f43ceb0b16b1f4e6c12894776d0e0475afe2f75fdf29539d1b7d9047d37a9c42708f6b5bf385a9f6d2c0029

data/MIT-LICENSE

@@ -1,4 +1,5 @@
-Copyright 2017 SportsEngine
+Copyright 2024 Emma Sax
+Copyright 2017-2024 SportsEngine
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -1,20 +1,21 @@
-[![Code Climate](https://codeclimate.com/github/sportngin/okcomputer.svg)](https://codeclimate.com/github/sportngin/okcomputer)
-[![Build Status](https://github.com/sportngin/okcomputer/workflows/CI/badge.svg)](https://github.com/sportngin/okcomputer/actions?query=workflow%3ACI)
+[![Gem Version](https://badge.fury.io/rb/okcomputer.svg)](https://badge.fury.io/rb/okcomputer)
+[![Downloads](https://img.shields.io/gem/dt/okcomputer.svg)](https://rubygems.org/gems/okcomputer)
+[![License](https://img.shields.io/github/license/emmahsax/okcomputer.svg)](LICENSE)
+[![Ruby Versions](https://img.shields.io/badge/Ruby-%3E%3D%202.1-brightgreen.svg)](https://www.ruby-lang.org)
+[![Build Status](https://github.com/emmahsax/okcomputer/actions/workflows/ci.yml/badge.svg)](https://github.com/emmahsax/okcomputer/actions/workflows/ci.yml)
 
-# OK Computer
+# OkComputer
 
-Inspired by the ease of installing and setting up [fitter-happier] as a Rails
+Inspired by the ease of installing and setting up [fitter-happier](https://rubygems.org/gems/fitter-happier) as a Rails
 application's health check, but frustrated by its lack of flexibility, OK
 Computer was born. It provides a robust endpoint to perform server health
 checks with a set of built-in plugins, as well as a simple interface to add
 your own custom checks.
 
 For more insight into why we built this, check out [our blog post introducing
-OK Computer][blog].
+OkComputer](http://pulse.sportngin.com/news_article/show/267646?referrer_id=543230).
 
-[blog]:http://pulse.sportngin.com/news_article/show/267646?referrer_id=543230
-
-OkComputer currently supports the following Rails versions:
+OkComputer currently fully supports the following Rails versions:
 
 * 7.0
 * 6.1
@@ -23,26 +24,38 @@ OkComputer currently supports the following Rails versions:
 * 5.1
 * 4.2
 
-#### Not using Rails?
+In addition, the CI tests are passing on, but is not guaranteed to work with, the following Rails versions:
 
-If you use [Grape] instead of Rails, check out [okcomputer-grape].
+* 8.0
+* 7.2
+* 7.1
+* 5.0
+* 4.1
+* 4.0
 
-[Grape]:https://github.com/ruby-grape/grape
-[okcomputer-grape]:https://github.com/bellycard/okcomputer-grape
+#### Not using Rails?
+
+If you use [Grape](https://github.com/ruby-grape/grape) instead of Rails, check out [okcomputer-grape](https://github.com/bellycard/okcomputer-grape).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'okcomputer'
+```ruby
+gem 'okcomputer'
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install okcomputer
+```
+$ gem install okcomputer
+```
 
 ## Usage
 
@@ -86,7 +99,7 @@ you can configure it with:
 
 ```ruby
 # config/initializers/okcomputer.rb
-OkComputer.mount_at = 'health_checks'    # mounts at /health_checks
+OkComputer.mount_at = 'health_checks' # Mounts at /health_checks
 ```
 
 For more control of adding OkComputer to your routes, set `OkComputer.mount_at
@@ -109,7 +122,7 @@ Log check results by setting `OkComputer.logger`. Note: results will be logged a
 OkComputer.logger = Rails.logger
 ```
 
-```sh
+```
 [okcomputer] mycheck: PASSED mymessage (0s)
 ```
 
@@ -124,6 +137,9 @@ OkComputer::Registry.register "resque_backed_up", OkComputer::ResqueBackedUpChec
 
 # This check works on 2.4.0 and above versions of resque-scheduler
 OkComputer::Registry.register "resque_scheduler_down", OkComputer::ResqueSchedulerCheck.new
+
+# If you're using SolidCache instead of Memcached, use this check instead of CacheCheck
+OkComputer::Registry.register "cache", OkComputer::CacheCheckSolidCache.new
 ```
 
 ### Registering Custom Checks
@@ -168,9 +184,7 @@ This check will run and report its status, but will not affect the HTTP status c
 The plain-text output flows through Rails' internationalization framework.
 Adjust the output as necessary by defining `okcomputer.check.passed` and
 `okcomputer.check.failed` keys in your setup. The default values are available
-[in `okcomputer.en.yml`][i18n].
-
-[i18n]:https://github.com/sportngin/okcomputer/blob/eb0be05cc1527e083edd63cfbb0a071f7892c822/config/locales/okcomputer.en.yml#L1-L5
+[in `okcomputer.en.yml`](https://github.com/emmahsax/okcomputer/blob/main/config/locales/okcomputer.en.yml).
 
 ## Running checks in parallel
 
@@ -198,7 +212,7 @@ as it will start to artificially bring your request time down.
 
 If you'd like to intentionally count OkComputer requests in your NewRelic analytics, set:
 
-```
+```ruby
 # config/initializers/okcomputer.rb
 OkComputer.analytics_ignore = false
 ```
@@ -207,7 +221,7 @@ OkComputer.analytics_ignore = false
 
 ### Setup
 
-```plaintext
+```
 $ bundle install
 ```
 
@@ -217,7 +231,7 @@ OkComputer tests are written with [RSpec](http://rspec.info/).
 
 To run the full test suite:
 
-```plaintext
+```
 $ rake spec
 ```
 
@@ -227,10 +241,17 @@ bundle and run the tests with a specific version of Rails.
 
 ## Contributing
 
-1. Fork it
+1. Fork this repository
 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
+5. Create a new pull request on upstream (this repository)
+6. Update [`CHANGELOG.markdown`](https://github.com/emmahsax/okcomputer/blob/main/CHANGELOG.markdown) under an `Unreleased` tag version (create a new one at the top if needed) with summarized changes and link to the pull request
+
+## Releasing
 
-[fitter-happier]:https://rubygems.org/gems/fitter-happier
+1. Ensure you have push permissions to [RubyGems](https://rubygems.org/gems/okcomputer)
+2. Merge all PRs so that `main` is up to date with the new version
+3. Determine the new version ([`lib/ok_computer/version`](https://github.com/emmahsax/okcomputer/blob/main/lib/ok_computer/version.rb) has the current latest one) by following [semantic versioning](https://semver.org/) guidelines
+4. Ensure you're on the `main` branch and you are locally up to date (`git checkout main && git pull`)
+5. Run the release script and pass in the new version (`bin/release vX.X.X`... the `v` at the beginning is optional)

data/Rakefile

@@ -23,4 +23,3 @@ begin
   end
 rescue LoadError
 end
-

data/lib/ok_computer/built_in_checks/active_record_migrations_check.rb

@@ -2,36 +2,37 @@ module OkComputer
   class ActiveRecordMigrationsCheck < Check
     # Public: Check if migrations are pending or not
     def check
-      return unsupported unless supported?
+      return mark_message(page_load_message) if check_on_page_load?
 
-      if needs_migration?
-        mark_failure
-        mark_message "Pending migrations"
-      else
-        mark_message "NO pending migrations"
-      end
-    end
+      error_if_pending_migrations(Rails.version)
 
-    def needs_migration?
-      if ActiveRecord::Migrator.respond_to?(:needs_migration?) # Rails <= 5.1
-        ActiveRecord::Migrator.needs_migration?
-      else # Rails >= 5.2
-        ActiveRecord::Base.connection.migration_context.needs_migration?
-      end
+      mark_message "NO pending migrations"
+    rescue ActiveRecord::PendingMigrationError
+      mark_failure
+      mark_message "Pending migrations"
     end
 
-    def supported?
-      ActiveRecord::Migrator.respond_to?(:needs_migration?) ||
-        (ActiveRecord::Base.connection.respond_to?(:migration_context) &&
-         ActiveRecord::Base.connection.migration_context.respond_to?(:needs_migration?))
+    private
+
+    # this check is only valid if config.active_record.migration_error is set to false rather than :page_load
+    # :page_load adds a Middleware check that throws an error before the call reaches ok_computer
+    # we only run this check when :page_load is set if there are no pending migrations
+    # :page_load is the default in development, otherwise this is false
+    # see https://github.com/rails/rails/blob/d39db5d1891f7509cde2efc425c9d69bbb77e670/activerecord/lib/active_record/railtie.rb#L103
+    def check_on_page_load?
+      Rails.configuration.active_record.migration_error
     end
 
-    private
+    def error_if_pending_migrations(version_string)
+      if Gem::Version.new(version_string) >= Gem::Version.new("7.1")
+        ActiveRecord::Migration.check_all_pending!
+      else
+        ActiveRecord::Migration.check_pending!
+      end
+    end
 
-    # Private: Fail the check if ActiveRecord cannot check migration status
-    def unsupported
-      mark_failure
-      mark_message "This version of ActiveRecord does not support checking whether migrations are pending"
+    def page_load_message
+      "NOTE: pending migrations are checked on page_load"
     end
   end
 end

data/lib/ok_computer/built_in_checks/cache_check_solid_cache.rb

@@ -0,0 +1,49 @@
+module OkComputer
+  # Verifies that Rails cache is set up and can speak with SolidCache
+  class CacheCheckSolidCache < Check
+    # Public: Check whether the cache is active
+    def check
+      mark_message "Cache is available (#{stats})"
+    rescue ConnectionFailed => e
+      mark_failure
+      mark_message "Error: '#{e}'"
+    end
+
+    # Public: Outputs stats string for cache
+    def stats
+      return "" unless Rails.cache.respond_to? :stats
+
+      stats = Rails.cache.stats
+      connection_stats = stats[:connection_stats][SolidCache::Entry.current_shard]
+
+      max_entries = connection_stats[:max_entries]
+      current_entries = connection_stats[:entries]
+      max_age = connection_stats[:max_age]
+      oldest_age = connection_stats[:oldest_age]
+
+      age_text = if oldest_age
+        "oldest: #{format_duration(oldest_age)}, max: #{format_duration(max_age)}"
+      else
+        "no entries"
+      end
+
+      "entries: #{current_entries}/#{max_entries}, #{age_text}, #{stats[:connections]} connections"
+    rescue => e
+      raise ConnectionFailed, e
+    end
+
+    private
+
+    def format_duration(seconds)
+      if seconds < 60
+        "#{seconds.round}s"
+      elsif seconds < 3600
+        "#{(seconds / 60).round}m"
+      else
+        "#{(seconds / 3600).round}h"
+      end
+    end
+
+    ConnectionFailed = Class.new(StandardError)
+  end
+end

data/lib/ok_computer/version.rb

@@ -1,3 +1,3 @@
 module OkComputer
-  VERSION = '1.18.6'
+  VERSION = '1.19.0'
 end

data/lib/okcomputer.rb

@@ -15,6 +15,7 @@ require "ok_computer/built_in_checks/active_record_check"
 require "ok_computer/built_in_checks/active_record_migrations_check"
 require "ok_computer/built_in_checks/app_version_check"
 require "ok_computer/built_in_checks/cache_check"
+require "ok_computer/built_in_checks/cache_check_solid_cache"
 require "ok_computer/built_in_checks/default_check"
 require "ok_computer/built_in_checks/delayed_job_backed_up_check"
 require "ok_computer/built_in_checks/directory_check"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: okcomputer
 version: !ruby/object:Gem::Version
-  version: 1.18.6
+  version: 1.19.0
 platform: ruby
 authors:
 - Patrick Byrne
@@ -12,68 +12,12 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-06 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: sequel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.6
-description: "\n    Inspired by the simplicity of Fitter Happier, but frustrated by
-  its lack of\n    flexibility, we built OK Computer. Create and register your own
-  custom\n    health checks, or choose from the built-in library of checks to ensure
-  your\n    app is working as intended.\n  "
+date: 2025-02-11 00:00:00.000000000 Z
+dependencies: []
+description: Inspired by the simplicity of Fitter Happier, but frustrated by its lack
+  of flexibility, we built OkComputer. Create and register your own custom health
+  checks, or choose from the built-in library of checks to ensure your app is working
+  as intended.
 email:
 - code@patrickbyrne.net
 - anfleene@gmail.com
@@ -95,6 +39,7 @@ files:
 - lib/ok_computer/built_in_checks/active_record_migrations_check.rb
 - lib/ok_computer/built_in_checks/app_version_check.rb
 - lib/ok_computer/built_in_checks/cache_check.rb
+- lib/ok_computer/built_in_checks/cache_check_solid_cache.rb
 - lib/ok_computer/built_in_checks/default_check.rb
 - lib/ok_computer/built_in_checks/delayed_job_backed_up_check.rb
 - lib/ok_computer/built_in_checks/directory_check.rb
@@ -140,14 +85,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.5
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A simple, extensible health-check monitor