katalyst-healthcheck 0.2.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 95661561842df409390e4a798c57b959bcbc39d0803f526fe39c4781b1e87903
+  data.tar.gz: a022ff2050eb06f96fa641bad74b0a1a0132b09b2e09cd9171654e2ce93f179d
+SHA512:
+  metadata.gz: bc2f21383a0ae5f28f40c072e746e265d481d5a3d99659f2b9dfe4bc2e73e85471a6d3a452f66ce4d3f26aed2eedecd36eab6fc9e4efd1e1936a33a7603a0c91
+  data.tar.gz: f6ade891f379e6abd9a959f07568e9e230a3d7ddeea83cd8337656bc8594536091a39bdcac3c948e9da42a4c7efeab8f41de074e8d9c7f285772d937bf03e086

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Andy Williams
+
+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,77 @@
+# Katalyst::Healthcheck
+
+Rails application and background task health monitoring.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'katalyst-healthcheck'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install katalyst-healthcheck
+```
+
+## Usage
+
+Configuration:
+
+Redis URL will automatically be set from Rails configuration, but can be configured
+manually in an initializer, e.g.
+```
+Katalyst::Healthcheck.configure do |config|
+  config.store.redis.options.url = "redis://hostname:port"
+end
+```
+
+Add to routes:
+
+```
+get '/healthcheck', to: Katalyst::Healthcheck::Route.static(200, "OK")
+get '/healthcheck/status', to: Katalyst::Healthcheck::Route.from_tasks
+get '/healthcheck/dashboard', to: Katalyst::Healthcheck::Route.from_tasks(detail: true)
+```
+
+With the above configuration, the following routes will be available:
+
+### /healthcheck
+
+A basic check that tests that the rails application is up and running.
+
+### /healthcheck/status
+
+Tests that all application background tasks are running as expected. 
+
+All background tasks to be monitored must register successful completion of their work using
+the `Katalyst::Healthcheck::Monitored` concern's `healthy!` and `unhealthy` methods, e.g.
+
+``` ruby
+include Katalyst::Healthcheck::Monitored
+
+define_task :my_task, "My task description", interval: 1.day
+
+def do_task
+  ... task code here ...
+  healthy!(:my_task)
+rescue Exception => e
+  unhealthy!(:my_task, e.message)
+end
+```
+
+Call `healthy!` at successful completion of a task to mark the task as healthy.
+Optionally, calling `unhealthy!` immediately marks that task as unhealthy.
+If a task is not marked as `healthy!` within a predefined interval, that task is considered unhealthy.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/katalyst/healthcheck/actions/sidekiq.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "sidekiq"
+
+module Katalyst
+  module Healthcheck
+    module Actions
+      class Sidekiq
+        include Katalyst::Healthcheck::Monitored
+        include ::Sidekiq::Worker
+
+        sidekiq_options retry: false
+
+        define_task :sidekiq_health, "Sidekiq background processing", interval: 60
+
+        def self.call
+          perform_async
+        end
+
+        def perform
+          self.class.healthy! :sidekiq_health
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/healthcheck/config.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Healthcheck
+    class Config
+      attr_reader :store
+
+      def initialize
+        self.store = :redis
+      end
+
+      def store=(name)
+        @store = build_store(name)
+      end
+
+      private
+
+      def build_store(name)
+        klass = "Katalyst::Healthcheck::Store::#{name.to_s.camelize}".constantize
+        klass.new
+      end
+    end
+  end
+end

data/lib/katalyst/healthcheck/monitored.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Healthcheck
+    module Monitored
+      extend ActiveSupport::Concern
+
+      module HealthMethods
+        # Define a task to be monitored
+        # @param name [Symbol] The name of the task
+        # @param description [String] A description of the task's function
+        # @param interval [Integer,ActiveSupport::Duration] Expected frequency that this task runs, e.g. 1.day
+        def define_task(name, description, interval:)
+          defined_healthcheck_tasks[name] = Task.new(name: name, description: description, interval: interval)
+        end
+
+        # Mark a task as healthy
+        # @param name [Symbol] The name of the task
+        def healthy!(name)
+          find_or_create_task(name).healthy!
+        end
+
+        # Mark a task as unhealthy
+        # @param name [Symbol] The name of the task
+        # @param error [String] Optional error message
+        def unhealthy!(name, error = nil)
+          find_or_create_task(name).unhealthy!(error)
+        end
+
+        private
+
+        def find_or_create_task(name)
+          task = Task.find(name)
+          if task.nil?
+            task = defined_healthcheck_tasks[name]
+            raise "task #{name} not found" if task.nil?
+
+            task.save
+          end
+          task
+        end
+      end
+
+      class_methods do
+        include HealthMethods
+
+        attr_accessor :healthcheck_task_definitions
+
+        # @return [Hash] Defined tasks keyed by name
+        def defined_healthcheck_tasks
+          self.healthcheck_task_definitions ||= {}
+        end
+      end
+
+      include HealthMethods
+
+      # @return [Hash] Defined tasks keyed by name
+      def defined_healthcheck_tasks
+        self.class.healthcheck_task_definitions ||= {}
+      end
+    end
+  end
+end

data/lib/katalyst/healthcheck/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Healthcheck
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        path = File.expand_path(__dir__)
+        Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+      end
+    end
+  end
+end

data/lib/katalyst/healthcheck/route.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Healthcheck
+    # Represents a status and a message that can be used in a rails route
+    class Route
+      class << self
+        def static(status, message)
+          Proc.new { |_env| [status, { "Content-Type" => "text/plain" }, [message]] }
+        end
+
+        def from_tasks(detail: false)
+          Proc.new do |_env|
+            tasks = Task.all
+            status = tasks.all?(&:ok?) ? 200 : 500
+            message = status == 200 ? "OK" : "FAIL"
+            message = Task.summary if detail
+            [status, { "Content-Type" => "text/plain" }, [message]]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/healthcheck/store/memory.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "redis"
+
+module Katalyst
+  module Healthcheck
+    module Store
+      # In-memory store, intended for spec tests and debugging
+      class Memory
+        attr_reader :state
+
+        def initialize(options = {})
+          @options = options
+          @state   = {}
+        end
+
+        # Read state from memory
+        # @return [Array<Hash>] List of tasks attribute data
+        def read
+          state.values
+        end
+
+        # Write state to memory
+        # @param name [String] name of the task
+        # @param task_state [Hash,nil] Task state
+        def update(name, task_state = {})
+          if task_state.nil?
+            state.delete(name)
+          else
+            state[name] = task_state
+          end
+        end
+
+        # Remove task state
+        # @param name [String] name of the task
+        def delete(name)
+          update(name, nil)
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/healthcheck/store/redis.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require "redis"
+require "json"
+
+module Katalyst
+  module Healthcheck
+    module Store
+      class Redis
+        DEFAULT_CACHE_KEY = "katalyst_healthcheck_tasks"
+        MAX_WRITE_TIME    = 5000 # milliseconds
+        DEFAULT_HOST      = "localhost"
+        DEFAULT_PORT      = 6379
+        DEFAULT_OPTIONS   = {
+          url:       "redis://#{DEFAULT_HOST}:#{DEFAULT_PORT}",
+          cache_key: DEFAULT_CACHE_KEY,
+        }.freeze
+
+        class << self
+          # @return [String] Redis URL defined in rails config
+          def rails_redis_url
+            redis_config = rails_redis_config || {}
+            host         = redis_config[:host] || DEFAULT_HOST
+            port         = redis_config[:port] || DEFAULT_PORT
+            "redis://#{host}:#{port}"
+          end
+
+          def rails_redis_config
+            Rails.application&.config_for(:redis)
+          rescue StandardError
+            {}
+          end
+        end
+
+        # @attr_reader options [OpenStruct] Redis configuration options
+        attr_reader :options
+
+        def initialize(options = {})
+          options  = { url: self.class.rails_redis_url }.merge(options) if defined?(Rails)
+          options  = DEFAULT_OPTIONS.merge(options)
+          @options = Struct.new(:url, :cache_key).new(options[:url], options[:cache_key])
+        end
+
+        # @return [Array<Hash>] List of tasks attribute data
+        def read
+          data  = fetch
+          tasks = data["tasks"] || {}
+          tasks.values
+        end
+
+        # Write task state
+        # @param name [String] name of the task
+        # @param task_state [Hash,nil] task details. If null, task state will be removed
+        def update(name, task_state = {})
+          lock_manager.lock!("#{cache_key}_lock", MAX_WRITE_TIME, {}) do
+            now                = Time.now
+            data               = fetch
+            data["version"]    = Katalyst::Healthcheck::VERSION
+            data["updated_at"] = now
+            data["created_at"] ||= now
+            task_data          = data["tasks"] ||= {}
+            if task_state.nil?
+              task_data.delete(name)
+            else
+              task_data[name] = serialize(task_state)
+            end
+            client.set(cache_key, JSON.generate(data))
+          end
+        end
+
+        # Remove task state
+        # @param name [String] name of the task
+        def delete(name)
+          update(name, nil)
+        end
+
+        private
+
+        # @param task_state [Hash]
+        def serialize(task_state)
+          task_state.transform_values do |value|
+            case value
+            when ActiveSupport::TimeWithZone, DateTime
+              value.strftime("%d/%m/%Y %H:%M:%S %z")
+            else
+              value
+            end
+          end
+        end
+
+        def cache_key
+          options.cache_key || DEFAULT_CACHE_KEY
+        end
+
+        # @return [Hash] Redis data for all tasks
+        def fetch
+          data = JSON.parse(client.get(cache_key) || "{}")
+          data = {} if data["version"] != Katalyst::Healthcheck::VERSION
+          data
+        end
+
+        def client
+          @client ||= ::Redis.new(options.to_h)
+        end
+
+        def lock_manager
+          raise "redis url is required" if options.url.blank?
+
+          @lock_manager ||= ::Redlock::Client.new([options.url])
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/healthcheck/task.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Healthcheck
+    # Represents a background task that runs periodically in an application
+    class Task
+      include ActiveModel::Model
+      include ActiveModel::Attributes
+
+      TASK_GRACE_PERIOD = 10 * 60 # 10 minutes
+
+      class << self
+        # @return tasks [Array<Task>] All tasks that have been registered
+        def all
+          store.read.map { |i| Task.new(i) }
+        end
+
+        # @param name [Symbol] name of the task
+        def find(name)
+          all.find { |task| task.name == name.to_s }
+        end
+
+        def find!(name)
+          find(name) || raise("Undefined task '#{name}'")
+        end
+
+        def destroy!(name)
+          store.delete(name)
+        end
+
+        def store
+          Katalyst::Healthcheck.config.store
+        end
+
+        # @return [String] Summary of task status
+        def summary
+          output = []
+          all.each do |task|
+            output << "#{task.name}:"
+            fields = [
+              ["Status", task.ok? ? "OK" : "FAIL"],
+              ["Description", task.description],
+              ["Error", task.error],
+            ]
+            fields.select { |i| i[1] }.each { |i| output << "  #{i.join(': ')}" }
+          end
+
+          output.join("\n")
+        end
+      end
+
+      attribute :name
+      attribute :last_time, :datetime
+      attribute :created_at, :datetime
+      attribute :updated_at, :datetime
+      attribute :interval, :integer
+      attribute :status
+      attribute :error
+      attribute :server
+      attribute :description
+
+      def ok?
+        status&.to_sym != :fail && on_schedule?
+      end
+
+      # @return [Boolean] true if this background task is running on schedule
+      def on_schedule?
+        next_time.nil? || next_time + TASK_GRACE_PERIOD > Time.current
+      end
+
+      def next_time
+        return nil if interval.blank?
+
+        (last_time || created_at) + interval
+      end
+
+      # Mark this task as healthy and save state
+      # @return [Task] This task
+      def healthy!
+        self.last_time = Time.current
+        self.error     = nil
+        self.status    = :ok
+
+        save
+      end
+
+      # Mark this task as unhealthy and save state
+      # @return [Task] This task
+      def unhealthy!(error = nil)
+        self.error  = error.presence || "Fail"
+        self.status = :fail
+
+        save
+      end
+
+      # Save task state
+      # @return [Task] This task
+      def save
+        self.created_at ||= Time.now
+        self.updated_at = Time.now
+        store.update(name, attributes)
+        self
+      end
+
+      def reload
+        Task.find(name)
+      end
+
+      private
+
+      def store
+        self.class.store
+      end
+    end
+  end
+end

data/lib/katalyst/healthcheck/tasks/healthcheck_tasks.rake

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+namespace :katalyst_healthcheck do
+  desc "Display health check information"
+  task info: :environment do
+    puts Katalyst::Healthcheck::Task.summary
+  end
+
+  desc "Clear status for a health check task"
+  task clear_task: :environment do
+    task_name = ENV["task_name"]
+    if task_name.nil?
+      puts "usage: rake #{ARGV[0]} task_name=name\n  task name is required."
+      exit 1
+    end
+
+    Katalyst::Healthcheck::Task.destroy!(task_name)
+    puts "cleared task status for task: #{task_name}"
+  end
+
+  desc "Call the sidekiq health check action to check that sidekiq is able to process background tasks"
+  task sidekiq: :environment do
+    Katalyst::Healthcheck::Actions::Sidekiq.call
+  end
+end

data/lib/katalyst/healthcheck/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Healthcheck
+    VERSION = "0.2.8"
+  end
+end

data/lib/katalyst/healthcheck.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_model"
+require "redlock"
+
+require "katalyst/healthcheck/version"
+require "katalyst/healthcheck/railtie" if defined?(Rails)
+require "katalyst/healthcheck/config"
+require "katalyst/healthcheck/store/memory"
+require "katalyst/healthcheck/store/redis"
+require "katalyst/healthcheck/task"
+require "katalyst/healthcheck/monitored"
+require "katalyst/healthcheck/route"
+require "katalyst/healthcheck/actions/sidekiq"
+
+module Katalyst
+  module Healthcheck
+    class << self
+      def config
+        @config ||= Config.new
+      end
+
+      def configure
+        instance_eval(&:block)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: katalyst-healthcheck
+version: !ruby/object:Gem::Version
+  version: 0.2.8
+platform: ruby
+authors:
+- Katalyst Interactive
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+- !ruby/object:Gem::Dependency
+  name: redlock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+description: 
+email:
+- admin@katalyst.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/katalyst/healthcheck.rb
+- lib/katalyst/healthcheck/actions/sidekiq.rb
+- lib/katalyst/healthcheck/config.rb
+- lib/katalyst/healthcheck/monitored.rb
+- lib/katalyst/healthcheck/railtie.rb
+- lib/katalyst/healthcheck/route.rb
+- lib/katalyst/healthcheck/store/memory.rb
+- lib/katalyst/healthcheck/store/redis.rb
+- lib/katalyst/healthcheck/task.rb
+- lib/katalyst/healthcheck/tasks/healthcheck_tasks.rake
+- lib/katalyst/healthcheck/version.rb
+homepage: https://github.com/katalyst/katalyst-healthcheck
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/katalyst/katalyst-healthcheck
+  source_code_uri: https://github.com/katalyst/katalyst-healthcheck
+  changelog_uri: https://github.com/katalyst/katalyst-healthcheck/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Health check routes and functions
+test_files: []