checkups 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4365201dccdda439c272becff16a31e9ace9e8eb924b20c63ae74b58e3430ee6
+  data.tar.gz: 03bdf297ce7b9f876dd777f6016ddeecb747b91b4a7c313481f44e2167f47546
+SHA512:
+  metadata.gz: c777b45a095f2597d937cbd42e80bd6ed21a9403155b844c3a3e31a1338cb2a723578c041d7d278d39ea4ded0aadacc14c937fd9fc861fc10911a0f50e3f9bd0
+  data.tar.gz: 1d657c9f5d375c3fdf1a7efdab01bb5b6515ea04a59cf3a585cc45d8033c5651589f3a6d1ca69495b19e7b198ae833c1c23dd924131ec2f4ba95046410f44a6b

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/bin/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,104 @@
+require:
+  - rubocop-performance
+#  - rubocop_lineup
+
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: disable
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+  ExpectedOrder:
+    - module_inclusion
+    - constants
+    - public_class_methods
+    - initializer
+    - public_methods
+    - protected_methods
+    - private_methods
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/LineLength:
+  Enabled: true
+  Max: 120
+  AllowHeredoc: true
+  AllowURI: true
+  URISchemes: http, https
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Metrics:
+  Enabled: true
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+  ExcludedMethods: ['included', 'namespace']
+
+Metrics/ClassLength:
+  Exclude:
+    - 'Rakefile'
+    - 'spec/**/*.rb'
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 15
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Style/BlockComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always_true
+  Enabled: true
+
+Style/GuardClause:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+Style/WhenThen:
+  Enabled: true
+
+Style/WordArray:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in checkups.gemspec
+gemspec
+
+gem "mocha"
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rubocop"
+gem "rubocop_lineup"
+gem "rubocop-performance"
+gem "timecop"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mystery Organization, Inc
+
+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/README.md

@@ -0,0 +1,60 @@
+# Checkups
+
+## Status: Jul 2020
+
+Ryan Laughlin gave a [great talk at RailsConf
+2018](https://www.youtube.com/watch?v=gEAlhKaK2I4) introducing our team to this
+concept of production checkups. Robb ran with it and I (chrismo :waves:) helped
+a little along the way. We've released what we have out to the internets in case
+anyone else wants to help out as well.
+
+As of our initial version here (0.9.0), we've got the core code in place, and
+some half-arsed Slack (for notifications) and Sidekiq integration (for custom
+worker checks). The goal for a 1.0 release is to figure out the proper way to
+handle 3rd party integrations.
+
+We use this gem in production at mysteryscience.com and this code has been live
+there for over a year.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'checkups'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install checkups
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/mysterysci/checkups.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new(:rubocop)
+
+task default: :rubocop

data/checkups.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "lib/checkups/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "checkups"
+  spec.version = Checkups::VERSION
+  spec.authors = %w[robbprescott chrismo]
+  spec.email = %w[robb@prescott.dev chrismo@clabs.org]
+
+  spec.summary = "Runtime checks on production conditions."
+  spec.homepage = "https://github.com/mysterysci/checkups"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/mysterysci/checkups"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  # spec.bindir = "exe"
+  # spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/checkups.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "logger"
+
+require "checkups/configuration"
+require "checkups/notification_timer"
+require "checkups/checkup"
+require "checkups/performance"
+require "checkups/slack_notifier"
+require "checkups/version"
+require "checkups/sidekiq_worker"
+
+module Checkups
+end

data/lib/checkups/checkup.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+# TODO: flesh out a manager class that can keep better track of the Checkup classes
+# TODO: \ and if they're being executed, so if something gets skipped for some reason
+# TODO: \ maybe it has a chance of being discovered instead of silently just never
+# TODO: \ being executed.
+module Checkups
+  class Checkup
+    attr_reader :status_message, :status, :verbose, :name, :url
+
+    def self.hourly
+      checkups_by_frequency(:hourly)
+    end
+
+    def self.daily
+      checkups_by_frequency(:daily)
+    end
+
+    # TODO: Remove verbose from method signature
+    def self.checkups_by_frequency(frequency, _verbose: false)
+      checkup_classes = ObjectSpace.each_object(::Class).select { |klass| klass < self }
+      checkup_classes.select { |klass| klass.frequency == frequency }
+    end
+
+    def self.frequency
+      :never
+    end
+
+    def initialize(verbose: false)
+      @notify_frequency = :always
+      @verbose = verbose
+      @name = nil
+      ok
+    end
+
+    def check_and_notify!(&block)
+      check(&block)
+      send_notification
+    rescue => e # rubocop:disable Style/RescueStandardError
+      handle_error(e)
+    end
+
+    def passed?
+      case check
+      when nil, :ok, :info
+        true
+      when :warning, :error
+        false
+      else
+        raise "Unknown status: #{check}"
+      end
+    end
+
+    def check
+      ok
+    end
+
+    def notify_message
+      "Checkup #{@status.to_s.capitalize}: " + @status_message
+    end
+
+    protected
+
+    def ok
+      set_status(:ok, nil)
+    end
+
+    def info(message)
+      set_status(:info, message)
+    end
+
+    def warning(message)
+      set_status(:warning, message)
+    end
+    alias warn warning
+
+    def error(message)
+      set_status(:error, message)
+    end
+
+    def send_notification
+      puts "#{status}#{status_message ? ': ' + status_message : ''}" if verbose
+
+      notifier.notify(self) if need_notification?
+    end
+
+    def notifier
+      @notifier ||= Checkups.configuration.notifier
+    end
+
+    def logger
+      @logger ||= Checkups.configuration.logger
+    end
+
+    def need_notification?
+      @status_message && NotificationTimer.new(@notify_frequency, @status).now?
+    end
+
+    def set_status(status, message)
+      @status_message = message
+      @status = status
+    end
+
+    # rubocop:disable Style/RescueStandardError
+    def handle_error(error)
+      message = "Error running Checkup class #{self.class.name}: #{error.message} #{error.backtrace[0]}"
+      set_status(:fatal, message)
+      notifier.notify(self)
+    rescue
+      # Last chance for gas
+      logger.error("Checkup handle_error error! #{error.message}") rescue nil # rubocop:disable Style/RescueModifier
+    end
+    # rubocop:enable Style/RescueStandardError
+  end
+end

data/lib/checkups/configuration.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Checkups
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :notifier, :logger
+
+    def initialize
+      @notifier = Checkups::SlackNotifier.new
+      @logger = Logger.new(IO::NULL)
+    end
+  end
+end

data/lib/checkups/notification_timer.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Checkups
+  class NotificationTimer
+    def initialize(frequency, status)
+      @frequency = frequency
+      @status = status
+    end
+
+    def now?
+      case @status
+      when :warning, :error
+        true
+      else
+        case @frequency
+        when :always
+          true
+        when /times_a_day/
+          word = @frequency.to_s.scan(/(.*)_times_a_day/).join
+          IntervalChecker.is_hour_at_day_interval?(word)
+        end
+      end
+    end
+  end
+
+  class IntervalChecker
+    # rubocop:disable Naming/PredicateName
+    def self.is_hour_at_day_interval?(daily_frequency, time = Time.now.utc)
+      frequency = word_to_number(daily_frequency) || 1
+      hourly_interval = 24 / frequency
+      time.utc.hour.divmod(hourly_interval)[1].zero?
+    end
+    # rubocop:enable Naming/PredicateName
+
+    def self.word_to_number(word)
+      case word
+      when String
+        {
+          "two" => 2,
+          "three" => 3,
+          "four" => 4,
+          "six" => 6,
+          "eight" => 8,
+        }[word]
+      else
+        word
+      end
+    end
+  end
+end

data/lib/checkups/performance.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Checkups
+  class Performance < Checkup
+    def self.frequency
+      :never
+    end
+
+    attr_reader :error_limit, :warning_limit
+
+    def initialize(verbose: false, name: nil, warning_limit: 1800, error_limit: 3600)
+      super(verbose: verbose)
+      @name = name
+      @warning_limit = warning_limit
+      @error_limit = error_limit
+      ok
+    end
+
+    def check
+      start_time = Time.now.to_i
+      yield
+      check_elapsed(Time.now.to_i - start_time)
+    end
+
+    def check_elapsed(elapsed)
+      if warning_limit <= elapsed && elapsed < error_limit
+        warning "#{name} took longer than #{warning_limit}s: #{elapsed}s"
+      elsif error_limit <= elapsed
+        error "#{name} took longer than #{error_limit}s: #{elapsed}s"
+      else
+        ok
+      end
+    end
+  end
+end

data/lib/checkups/sidekiq_worker.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+if defined?(Sidekiq)
+  require "sidekiq"
+  require "active_support/core_ext/string/inflections"
+
+  module Checkups
+    class SidekiqWorker
+      include Sidekiq::Worker
+
+      sidekiq_options retry: 3
+
+      # :hourly or :daily, spread them out over time
+      def perform(frequency, verbose = false)
+        Checkup.checkups_by_frequency(frequency.to_sym).each_with_index do |klass, i|
+          OneCheckupWorker.perform_in(i * 10, klass.name, verbose)
+        end
+      end
+    end
+
+    class OneCheckupWorker
+      include Sidekiq::Worker
+
+      sidekiq_options retry: 3
+
+      # :hourly or :daily
+      def perform(klass, verbose = false)
+        klass.constantize.new(verbose: verbose).tap do |checkup|
+          printf "Checkup: #{klass}..." if verbose
+          checkup.check_and_notify!
+        end
+      end
+    end
+  end
+end

data/lib/checkups/slack_notifier.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Checkups
+  class SlackNotifier
+    def notify(checkup)
+      attachments = build_attachments(checkup.status,
+                                      checkup.notify_message,
+                                      checkup.name,
+                                      checkup.url)
+      send_attachments(attachments)
+    end
+
+    def send_attachments(_attachments)
+      raise "Must subclass Checkups::SlackNotifier#send_attachments"
+    end
+
+    # https://api.slack.com/docs/message-attachments#attachment_structure
+    def build_attachments(status, message, title = nil, title_link = nil)
+      attachment = {"color": status_to_slack_color(status),
+                    "text": message}
+      attachment[:title] = title if title
+      attachment[:title_link] = title_link if title_link
+      [attachment]
+    end
+
+    def status_to_slack_color(status)
+      case status
+      when :ok, :info
+        "good"
+      when :warning
+        "warning"
+      when :error, :fatal
+        "danger"
+      end
+    end
+  end
+end

data/lib/checkups/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Checkups
+  VERSION = "0.9.0"
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: checkups
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- robbprescott
+- chrismo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-27 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- robb@prescott.dev
+- chrismo@clabs.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- checkups.gemspec
+- lib/checkups.rb
+- lib/checkups/checkup.rb
+- lib/checkups/configuration.rb
+- lib/checkups/notification_timer.rb
+- lib/checkups/performance.rb
+- lib/checkups/sidekiq_worker.rb
+- lib/checkups/slack_notifier.rb
+- lib/checkups/version.rb
+homepage: https://github.com/mysterysci/checkups
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mysterysci/checkups
+  source_code_uri: https://github.com/mysterysci/checkups
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Runtime checks on production conditions.
+test_files: []