sidekiq-err 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 540a25393182c06c16aa1133a3eb97a382a4e7918d37564ab48ea1f5244b3bad
+  data.tar.gz: 1780bcba830dc7332e999381ade9e86f0480d4386727aef14f7f680ea1e0efd6
+SHA512:
+  metadata.gz: 0d40784c25269602e7b9698583f27a0cc0a6c760693bc0947a5a816789b4a29ee79dc16fe6d5e8598a5efd090e84aba1123c3ea5080681664a9e76e7469d5418
+  data.tar.gz: 12b25794cdb14be82e0a048037596d897764f3b56bb2b875904cd8909c1266f67f9475725fbecae9bf2ca7bf0aa4d584fcc9caa06c6c30b78cddba74f033cd6a

data/exe/sidekiq-err

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'sidekiq-err'
+
+require 'pry' if ENV.fetch('USE_PRY', false)
+
+# main entry point
+begin
+  case ARGV[0]
+  when '-a', '--alive'
+    SidekiqErr.alive?
+  when '-r', '--report'
+    SidekiqErr.status(ARGV[1])
+  when '-h', '--help'
+    SidekiqErr.print_usage
+  else
+    puts
+    puts 'Uknown command, use --help for usage details'
+    puts
+  end
+rescue SidekiqErr::Error, Redis::CannotConnectError, Redis::TimeoutError => e
+  puts "Error: #{e.message}"
+  puts
+  exit(1)
+end

data/lib/sidekiq-err/alive.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module SidekiqErr
+  class Alive
+    def self.check?
+      process_set = Sidekiq::ProcessSet.new
+      raise(NoProcessFound, 'No sidekiq process running!') if process_set.size.zero?
+    end
+  end
+end

data/lib/sidekiq-err/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SidekiqErr
+  class Error < StandardError; end
+  class NoProcessFound < Error; end
+end

data/lib/sidekiq-err/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SidekiqErr
+  VERSION = '0.1.0'
+end

data/lib/sidekiq-err/view.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module SidekiqErr
+  class View
+    class InvalidSection < SidekiqErr::Error; end
+
+    attr_reader :section
+
+    def self.valid_sections
+      @valid_sections ||= %w[all version overview processes queues].freeze
+    end
+
+    def initialize(section)
+      @section = section
+    end
+
+    def display
+      if invalid_section?(section)
+        msg = "Invalid section for status check: '#{section}'"
+        msg += "\nTry one of these: #{self.class.valid_sections.join(', ')}"
+        raise(InvalidSection, msg)
+      end
+
+      send(section)
+    end
+
+    def all
+      version
+      puts
+      overview
+      puts
+      processes
+      puts
+      queues
+    end
+
+    def version
+      puts "Sidekiq #{Sidekiq::VERSION}"
+      puts Time.now.utc
+    end
+
+    def overview
+      puts '---- Overview ----'
+      puts "  Processed: #{delimit stats.processed}"
+      puts "     Failed: #{delimit stats.failed}"
+      puts "       Busy: #{delimit stats.workers_size}"
+      puts "   Enqueued: #{delimit stats.enqueued}"
+      puts "    Retries: #{delimit stats.retry_size}"
+      puts "  Scheduled: #{delimit stats.scheduled_size}"
+      puts "       Dead: #{delimit stats.dead_size}"
+    end
+
+    def processes
+      puts "---- Processes (#{process_set.size}) ----"
+      process_set.each_with_index do |process, index|
+        puts "#{process['identity']} #{tags_for(process)}"
+        puts "  Started: #{Time.at(process['started_at'])} (#{time_ago(process['started_at'])})"
+        puts "  Threads: #{process['concurrency']} (#{process['busy']} busy)"
+        puts "   Queues: #{split_multiline(process['queues'].sort, pad: 11)}"
+        puts '' unless (index+1) == process_set.size
+      end
+    end
+
+    COL_PAD = 2
+    def queues
+      puts "---- Queues (#{queue_data.size}) ----"
+      columns = {
+        name: [:ljust, (['name'] + queue_data.map(&:name)).map(&:length).max + COL_PAD],
+        size: [:rjust, (['size'] + queue_data.map(&:size)).map(&:length).max + COL_PAD],
+        latency: [:rjust, (['latency'] + queue_data.map(&:latency)).map(&:length).max + COL_PAD]
+      }
+      columns.each { |col, (dir, width)| print col.to_s.upcase.public_send(dir, width) }
+      puts
+      queue_data.each do |q|
+        columns.each do |col, (dir, width)|
+          print q.send(col).public_send(dir, width)
+        end
+        puts
+      end
+    end
+
+    private
+
+    def delimit(number)
+      number.to_s.reverse.scan(/.{1,3}/).join(',').reverse
+    end
+
+    def split_multiline(values, opts = {})
+      return 'none' unless values
+
+      pad = opts[:pad] || 0
+      max_length = opts[:max_length] || (80 - pad)
+      out = []
+      line = ''.dup
+      values.each do |value|
+        if (line.length + value.length) > max_length
+          out += line
+          line = ' ' * pad
+        end
+        line += "#{value}, "
+      end
+      out << line[0..-3]
+      out.join("\n")
+    end
+
+    def tags_for(process)
+      tags = [
+        process['tag'],
+        process['labels'],
+        (process['quiet'] == 'true' ? 'quiet' : nil)
+      ].flatten.compact
+      tags.any? ? "[#{tags.join('] [')}]" : nil
+    end
+
+    def time_ago(timestamp)
+      seconds = Time.now - Time.at(timestamp)
+      return 'just now' if seconds < 60
+      return 'a minute ago' if seconds < 120
+      return "#{seconds.floor / 60} minutes ago" if seconds < 3600
+      return 'an hour ago' if seconds < 7200
+
+      "#{seconds.floor / 60 / 60} hours ago"
+    end
+
+    QUEUE_STRUCT = Struct.new(:name, :size, :latency)
+    def queue_data
+      @queue_data ||= Sidekiq::Queue.all.map do |q|
+        QUEUE_STRUCT.new(q.name, q.size.to_s, sprintf('%#.2f', q.latency))
+      end
+    end
+
+    def process_set
+      @process_set ||= Sidekiq::ProcessSet.new
+    end
+
+    def stats
+      @stats ||= Sidekiq::Stats.new
+    end
+
+    def invalid_section?(section)
+      !self.class.valid_sections.include?(section)
+    end
+  end
+end

data/lib/sidekiq-err.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'sidekiq-err/version'
+require 'sidekiq-err/error'
+require 'sidekiq-err/alive'
+require 'sidekiq-err/view'
+require 'fileutils'
+require 'sidekiq/api'
+
+module SidekiqErr
+  CMD = File.basename($PROGRAM_NAME)
+
+  def self.print_usage
+    puts "#{CMD} - Sidekiq process reporting."
+    puts
+    puts "Usage: #{CMD}"
+    puts
+    puts '       -a, --alive'
+    puts '         check if at least 1 Sidekiq process is running'
+    puts '         sets the exit code to 1 if no process if found'
+    puts
+    puts '       -r, --report [SECTION_NAME]'
+    puts '         view the status report'
+    puts '         SECTION_NAME is optional and filters the report to a specific section'
+    puts "         Valid sections are: #{View.valid_sections.join(', ')}"
+    puts "         Default is 'all'"
+    puts
+  end
+
+  def self.status(section = nil)
+    section ||= 'all'
+    SidekiqErr::View.new(section).display
+  end
+
+  def self.alive?
+    SidekiqErr::Alive.check?
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-err
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Campbell Allen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rake
+  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
+  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'
+description: Status of your sidekiq system - useful for Kubernetes liveness probes
+email:
+- campbell.allen@gmail.com
+executables:
+- sidekiq-err
+extensions: []
+extra_rdoc_files: []
+files:
+- exe/sidekiq-err
+- lib/sidekiq-err.rb
+- lib/sidekiq-err/alive.rb
+- lib/sidekiq-err/error.rb
+- lib/sidekiq-err/version.rb
+- lib/sidekiq-err/view.rb
+homepage: https://github.com/camallen/sidekiq-err
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/camallen/sidekiq-err
+  source_code_uri: https://github.com/camallen/sidekiq-err
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key:
+specification_version: 4
+summary: Status of your sidekiq system - useful for Kubernetes liveness probes
+test_files: []