http_health_check 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd248ef72a5036149bbeebe0dbbf989691b929f8c9ad49b51505ad01086931f2
-  data.tar.gz: 566d608465c448b64358d49c89ee3328a586541afc30dedaabd735d8b9f3f846
+  metadata.gz: 1ae08f694494aa01e0667a635ae85163e9d675da9a8e97bb1ad9194296c113d0
+  data.tar.gz: 44b3ae8a18369eaf1da10c9ba7283272a395f2afda8fe6e964cc2fc1643e2bc5
 SHA512:
-  metadata.gz: ac50f1370a1c85b97f1dd420816a008cd560def8e076545ffa2258552ceeb47b2bea22252751ea3db09fc4716aea1b7eb0dadc876d42be43a5d7ac024b140d0e
-  data.tar.gz: f804bf50fc6a96cab3f8f568008fc6c89a8aee84ad4a6ae8e6258589f474ef290664658515867793cc95dbd7abc768b1b5eacde24c375a0ef89e3ac9259d7837
+  metadata.gz: '069a950fe9727f24980ad7b38014d73369a7963796606c2d3fddfdfa13da3e710776ba24174dfc9d511175a65d05aa40b6b3f5d15aba3c53380f84a088af3309'
+  data.tar.gz: b149e9ae46abbcc0131f652135e19aca4e747adaa3f39913457a0e768f38b1b697fd470ffc1bc6e2eee952b847bf8359a1653d699a34f41cf8f0e44c9a76a6fb

data/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.2.1
+current_version = 0.4.0
 commit = True
 tag = True
 tag_name = {new_version}
@@ -8,3 +8,7 @@ message = bump version {current_version} → {new_version}
 [bumpversion:file:lib/http_health_check/version.rb]
 
 [bumpversion:file:README.md]
+
+[bumpversion:file:Gemfile.lock]
+search = http_health_check ({current_version})
+replace = http_health_check ({new_version})

data/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: ci
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["2.5", "2.6", "2.7", "3.0"]
+    services:
+      redis:
+        image: bitnami/redis:6.2
+        ports:
+          - 6379:6379
+        env:
+          REDIS_PASSWORD: supersecret
+        options: >-
+          --health-cmd "redis-cli -p 6379 -a 'supersecret' ping"
+          --health-interval 1s
+          --health-timeout 3s
+          --health-retries 10
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+      - name: Run all tests
+        run: bundle exec rspec
+        env:
+          REDIS_URL: redis://:supersecret@redis:${{ job.services.redis.ports[6379] }}/0
+          # FIXME!
+          SKIP_REDIS_SPECS: true
+      - name: Run rubocop
+        run: bundle exec rubocop

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 /.idea
+*.gem

data/.rubocop.yml

@@ -6,4 +6,8 @@ Style/Documentation:
 
 Metrics/BlockLength:
   Exclude:
-    - 'spec/**/*.rb'
+    - "spec/**/*.rb"
+    - "http_health_check.gemspec"
+
+Style/CommentedKeyword:
+  Enabled: false

data/CHANGELOG.md

@@ -1,12 +1,22 @@
 # CHANGELOG.md
 
-## 0.1.1 (2022-07-17)
+## 0.4.0 (2022-07-20)
 
 Features:
 
-- implement basic functionality
-- add builtin sidekiq probe
-- add builtin delayed job probe
+- add karafka consumer groups utility function
+
+## 0.3.0 (2022-07-19)
+
+Features:
+
+- add ruby-kafka probe
+
+## 0.2.1 (2022-07-18)
+
+Fix:
+
+- fix gemspec
 
 ## 0.2.0 (2022-07-18)
 
@@ -18,8 +28,10 @@ Fix:
 
 - fix builtin probes requirement
 
-## 0.2.1 (2022-07-18)
+## 0.1.1 (2022-07-17)
 
-Fix:
+Features:
 
-- fix gemspec
+- implement basic functionality
+- add builtin sidekiq probe
+- add builtin delayed job probe

data/Gemfile.lock

@@ -1,16 +1,26 @@
 PATH
   remote: .
   specs:
-    http_health_check (0.2.0)
+    http_health_check (0.4.0)
       rack (~> 2.0)
+      webrick
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (5.2.8.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
     ast (2.4.2)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
     docile (1.4.0)
     dotenv (2.7.6)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.15.0)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
@@ -56,12 +66,20 @@ GEM
       simplecov (~> 0.19)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
+    thor (1.1.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
     unicode-display_width (1.8.0)
+    webrick (1.7.0)
 
 PLATFORMS
+  ruby
   x86_64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
+  activesupport (~> 5.0)
   dotenv (~> 2.7.6)
   http_health_check!
   rake (~> 13.0)
@@ -71,6 +89,7 @@ DEPENDENCIES
   rubocop (~> 0.81)
   simplecov
   simplecov-cobertura
+  thor (>= 0.20)
 
 BUNDLED WITH
    2.3.15

data/README.md

@@ -2,12 +2,16 @@
 
 [![Gem Version](https://badge.fury.io/rb/http_health_check.svg)](https://badge.fury.io/rb/http_health_check)
 
+HttpHealthCheck is a tiny framework for building health check for your application components. It provides a set of built-in checkers (a.k.a. probes) and utilities for building your own.
+
+HttpHealthCheck is built with kubernetes health probes in mind, but it can be used with http health checker.
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'http_health_check', '~> 0.2.1'
+gem 'http_health_check', '~> 0.4.0'
 ```
 
 And then execute:
@@ -45,6 +49,91 @@ module Delayed::AfterFork
 end
 ```
 
+### Karafka ~> 1.4
+
+Ruby-kafka probe is disabled by default as it requires app-specific configuration to work properly. Example usage with karafka framework:
+
+```ruby
+# ./karafka.rb
+
+class KarafkaApp < Karafka::App
+  # ...
+  # karafka app configuration
+  # ...
+end
+
+KarafkaApp.boot!
+
+HttpHealthCheck.run_server_async(
+  port: 5555,
+  rack_app: HttpHealthCheck::RackApp.configure do |c|
+    c.probe '/readiness/karafka', HttpHealthCheck::Probes::RubyKafka.new(
+      consumer_groups: HttpHealthCheck::Utils::Karafka.consumer_groups(KarafkaApp),
+      # default heartbeat interval is 3 seconds, but we want to give it
+      # an ability to skip a few before failing the probe
+      heartbeat_interval_sec: 10,
+      # includes a list of topics and partitions into response for every consumer thread. false by default
+      verbose: false
+    )
+  end
+)
+```
+
+Ruby kafka probe supports multi-threaded setups, i.e. if you are using karafka and you define multiple blocks with the same consumer group like
+
+```ruby
+class KarafkaApp < Karafka::App
+  consumer_groups.draw do
+    consumer_group 'foo' do
+      # ...
+    end
+  end
+
+  consumer_groups.draw do
+    consumer_group 'foo' do
+      # ...
+    end
+  end
+end
+
+HttpHealthCheck::Utils::Karafka.consumer_groups(KarafkaApp)
+# => ['foo', 'foo']
+```
+
+ruby-kafka probe will count heartbeats from multiple threads.
+
+### Kubernetes deployment example
+
+```yaml
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: sidekiq
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: sidekiq
+  template:
+    metadata:
+      labels:
+        app: sidekiq
+    spec:
+      containers:
+        - name: sidekiq
+          image: my-app:latest
+          livenessProbe:
+            httpGet:
+              path: /liveness
+              port: 5555
+              scheme: HTTP
+          readinessProbe:
+            httpGet:
+              path: /readiness/sidekiq
+              port: 5555
+              scheme: HTTP
+```
+
 ### Changing global configuration
 
 ```ruby
@@ -57,7 +146,7 @@ HttpHealthCheck.configure do |c|
     [200, {}, ['OK']]
   end
 
-  # optionally add builtin probes
+  # optionally add built-in probes
   HttpHealthCheck.add_builtin_probes(c)
 
   # optionally override fallback (route not found) handler
@@ -83,7 +172,7 @@ HttpHealthCheck.run_server_async(port: 5555, rack_app: rack_app)
 
 Probes are built around [HttpHealthCheck::Probe](./lib/http_health_check/probe.rb) mixin. Every probe defines **probe** method which receives [rack env](https://www.rubydoc.info/gems/rack/Rack/Request/Env)
 and should return [HttpHealthCheck::Probe::Result](./lib/http_health_check/probe/result.rb) or rack-compatible response (status-headers-body tuple).
-Probe-mixin provides convenience methods `probe_ok` and `probe_error` for creating [HttpHealthCheck::Probe::Result](./lib/http_health_check/probe/result.rb) instance. Both of them accept optional metadata hash that will be added to response body.
+Probe-mixin provides convenience methods `probe_ok` and `probe_error` for creating [HttpHealthCheck::Probe::Result](./lib/http_health_check/probe/result.rb) instance. Both of them accept optional metadata hash that will be added to the response body.
 Any exception (StandardError) will be captured and converted into error-result.
 
 ```ruby
@@ -105,12 +194,12 @@ HttpHealthCheck.configure do |config|
 end
 ```
 
-### Builtin probes
+### Built-in probes
 
 #### [Sidekiq](./lib/http_health_check/probes/sidekiq.rb)
 
 Sidekiq probe ensures that sidekiq is ready by checking redis is available and writable. It uses sidekiq's redis connection pool to avoid spinning up extra connections.
-Be aware, that this approach does not cover issues with sidekiq being stuck processing slow/endless jobs. Such cases are nearly impossible to cover without false-positive alerts.
+Be aware that this approach does not cover issues with sidekiq being stuck processing slow/endless jobs. Such cases are nearly impossible to cover without false-positive alerts.
 
 ```ruby
 HttpHealthCheck.configure do |config|
@@ -121,8 +210,8 @@ end
 #### [DelayedJob](./lib/http_health_check/probes/delayed_job.rb) (active record)
 
 Delayed Job probe is intended to work with [active record backend](https://github.com/collectiveidea/delayed_job_active_record).
-It checks DelayedJob is healthy by enqueuing an empty job which will be deleted right after insertion. This allows us to be sure that underlying database is connectable and writable.
-Be aware, that by enqueuing a new job with every health check we are incrementing primary key sequence.
+It checks DelayedJob is healthy by enqueuing an empty job which will be deleted right after insertion. This allows us to be sure that the underlying database is connectable and writable.
+Be aware that by enqueuing a new job with every health check, we are incrementing the primary key sequence.
 
 ```ruby
 HttpHealthCheck.configure do |config|
@@ -130,6 +219,20 @@ HttpHealthCheck.configure do |config|
 end
 ```
 
+#### [ruby-kafka](./lib/http_health_check/probes/ruby_kafka.rb)
+
+ruby-kafka probe is expected to be configured with consumer groups list. It subscribes to ruby-kafka's `heartbeat.consumer.kafka` ActiveSupport notification and tracks heartbeats for every given consumer group.
+It expects a heartbeat every `:heartbeat_interval_sec` (10 seconds by default).
+
+```ruby
+heartbeat_app = HttpHealthCheck::RackApp.configure do |c|
+  c.probe '/readiness/kafka', HttpHealthCheck::Probes::Karafka.new(
+    consumer_groups: ['consumer-one', 'consumer-two'],
+    heartbeat_interval_sec: 42
+  )
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -141,8 +244,6 @@ docker-compose up redis
 
 ## Deployment
 
-Every new (git) tag will be built and deployed automatically via gitlab CI pipeline. We recommend using [bump2version](https://github.com/c4urself/bump2version) to tag new releases.
-
 1. Update changelog and git add it
 2.
 
@@ -151,3 +252,5 @@ bump2version patch --allow-dirty
 ```
 
 3. git push && git push --tags
+4. gem build
+5. gem push http_health_check-x.x.x.gem

data/docker-compose.yml

@@ -1,7 +1,7 @@
 version: '3.5'
 services:
   redis:
-    image: dreg.sbmt.io/dhub/bitnami/redis:6.2
+    image: bitnami/redis:6.2
     environment:
       REDIS_PASSWORD: supersecret
     volumes:

data/http_health_check.gemspec

@@ -28,9 +28,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'rack', '~> 2.0'
+  spec.add_dependency 'webrick'
 
+  spec.add_development_dependency 'activesupport', '~> 5.0'
   spec.add_development_dependency 'dotenv', '~> 2.7.6'
   spec.add_development_dependency 'redis', '~> 4.2.5'
   spec.add_development_dependency 'rspec', '~> 3.2'
   spec.add_development_dependency 'rubocop', '~> 0.81'
+  spec.add_development_dependency 'thor', '>= 0.20'
 end

data/lib/http_health_check/probes/ruby_kafka.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module HttpHealthCheck
+  module Probes
+    class RubyKafka
+      Heartbeat = Struct.new(:time, :group, :topic_partitions)
+      include ::HttpHealthCheck::Probe
+
+      def initialize(opts = {})
+        @heartbeat_event_name = opts.fetch(:heartbeat_event_name, /heartbeat.consumer.kafka/)
+        @heartbeat_interval_sec = opts.fetch(:heartbeat_interval_sec, 10)
+        @verbose = opts.fetch(:verbose, false)
+        @consumer_groups = opts.fetch(:consumer_groups)
+                               .each_with_object(Hash.new(0)) { |group, hash| hash[group] += 1 }
+        @heartbeats = {}
+        @timer = opts.fetch(:timer, Time)
+
+        setup_subscriptions
+      end
+
+      def probe(_env)
+        now = @timer.now
+        failed_heartbeats = select_failed_heartbeats(now)
+        return probe_ok groups: meta_from_heartbeats(@heartbeats, now) if failed_heartbeats.empty?
+
+        probe_error failed_groups: meta_from_heartbeats(failed_heartbeats, now)
+      end
+
+      private
+
+      def select_failed_heartbeats(now)
+        @consumer_groups.each_with_object({}) do |(group, concurrency), hash|
+          heartbeats = @heartbeats[group] || {}
+          ok_heartbeats_count = heartbeats.count { |_id, hb| hb.time + @heartbeat_interval_sec >= now }
+          hash[group] = heartbeats if ok_heartbeats_count < concurrency
+        end
+      end
+
+      def meta_from_heartbeats(heartbeats_hash, now) # rubocop: disable Metrics/MethodLength, Metrics/AbcSize
+        heartbeats_hash.each_with_object({}) do |(group, heartbeats), hash|
+          concurrency = @consumer_groups[group]
+          if heartbeats.empty?
+            hash[group] = { had_heartbeat: false, concurrency: concurrency }
+            next
+          end
+
+          hash[group] = { had_heartbeat: true, concurrency: concurrency, threads: {} }
+          heartbeats.each do |thread_id, heartbeat|
+            thread_meta = { seconds_since_last_heartbeat: now - heartbeat.time }
+            thread_meta[:topic_partitions] = heartbeat.topic_partitions if @verbose
+            hash[group][:threads][thread_id] = thread_meta
+          end
+        end
+      end
+
+      def setup_subscriptions
+        ActiveSupport::Notifications.subscribe(@heartbeat_event_name) do |*args|
+          event = ActiveSupport::Notifications::Event.new(*args)
+          group = event.payload[:group_id]
+
+          @heartbeats[group] ||= {}
+          @heartbeats[group][event.transaction_id] = Heartbeat.new(event.time, group, event.payload[:topic_partitions])
+        end
+      end
+    end
+  end
+end

data/lib/http_health_check/probes.rb

@@ -2,6 +2,7 @@
 
 require_relative 'probes/sidekiq' if defined?(::Sidekiq)
 require_relative 'probes/delayed_job' if defined?(::Delayed::Job)
+require_relative 'probes/ruby_kafka' if defined?(::Kafka::Consumer)
 
 module HttpHealthCheck
   module Probes; end

data/lib/http_health_check/utils/karafka.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module HttpHealthCheck
+  module Utils
+    module Karafka
+      # returns a list of consumer groups configured for current process
+      #
+      # @param karafka_app descendant of Karafka::App
+      def self.consumer_groups(karafka_app, program_name: $PROGRAM_NAME, argv: ARGV) # rubocop:disable Metrics/AbcSize
+        all_groups = karafka_app.consumer_groups.map(&:id)
+        client_id_prefix = karafka_app.config.client_id.gsub('-', '_') + '_'
+
+        return all_groups if program_name.split('/').last != 'karafka'
+        return all_groups if argv[0] != 'server'
+
+        parsed_option = Thor::Options.new(
+          consumer_groups: Thor::Option.new(:consumer_groups, type: :array, default: nil, aliases: :g)
+        ).parse(argv).fetch('consumer_groups', []).first.to_s
+        return all_groups if parsed_option == ''
+
+        groups_from_option = parsed_option.split(' ').map { |g| client_id_prefix + g } & all_groups
+        groups_from_option.empty? ? all_groups : groups_from_option
+      end
+    end
+  end
+end

data/lib/http_health_check/utils.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'utils/karafka' if defined?(::Karafka::App)
+
+module HttpHealthCheck
+  module Utils; end
+end

data/lib/http_health_check/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HttpHealthCheck
-  VERSION = '0.2.1'
+  VERSION = '0.4.0'
 end

data/lib/http_health_check.rb

@@ -7,6 +7,7 @@ require_relative 'http_health_check/config/dsl'
 require_relative 'http_health_check/probe'
 require_relative 'http_health_check/rack_app'
 require_relative 'http_health_check/probes'
+require_relative 'http_health_check/utils'
 
 module HttpHealthCheck
   class Error < StandardError; end
@@ -36,7 +37,7 @@ module HttpHealthCheck
   end
 
   def self.run_server_async(opts)
-    Thread.new { run_server(opts) }
+    Thread.new { run_server(**opts) }
   end
 
   def self.run_server(port:, host: '0.0.0.0', rack_app: nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: http_health_check
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - SberMarket team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-18 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.81'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
 description: Simple and extensible HTTP health checks server.
 email:
 - pochi.73@gmail.com
@@ -89,6 +131,7 @@ extra_rdoc_files: []
 files:
 - ".bumpversion.cfg"
 - ".env"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -109,8 +152,11 @@ files:
 - lib/http_health_check/probe/result.rb
 - lib/http_health_check/probes.rb
 - lib/http_health_check/probes/delayed_job.rb
+- lib/http_health_check/probes/ruby_kafka.rb
 - lib/http_health_check/probes/sidekiq.rb
 - lib/http_health_check/rack_app.rb
+- lib/http_health_check/utils.rb
+- lib/http_health_check/utils/karafka.rb
 - lib/http_health_check/version.rb
 homepage: https://github.com/SberMarket-Tech/http_health_check
 licenses: