sidekiq_monitoring_bitcrowd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fbc1b833ad154e54aca350d51e7ba5456f5691ab
+  data.tar.gz: 3503d4af9262baa6cdf6ce68ae3b909abd908c06
+SHA512:
+  metadata.gz: fb19f2c938947b7053b8374224c18fc011bdfa611926aa8f55a9fc8d73302517d64d7ef48be9e589cc95f91c5aeed6750454b38629c7c4512e57956410a069b4
+  data.tar.gz: cdfb47713d49f69448a5ea40dac772929112eff3566831a6b600ddbb344a28dd1bf53c67f0d3c2c2875d045bc8f288f018f77f7e88b4a8b9868d6c4867afa0e8

data/README.md

@@ -0,0 +1,80 @@
+# sidekiq_monitoring_bitcrowd [![Build Status](https://travis-ci.org/bitcrowd/sidekiq_monitoring.svg?branch=master)](https://travis-ci.org/bitcrowd/sidekiq_monitoring)
+
+Rails engine that provides a JSON API which serves Sidekiq
+status information from a HTTP-auth protected endpoint.
+This status information is gathered by scheduling a frequently
+running job that saves timestamps in Redis.
+
+## Installation
+
+Add gem to your project:
+
+    gem 'sidekiq_monitoring_bitcrowd'
+
+Mount engine in `routes.rb`:
+
+    Rails.application.routes.draw do
+      mount SidekiqMonitoring::Engine => '/sidekiq_monitoring'
+    end
+
+Schedule job in `whenever`'s `schedule.rb`:
+
+    every 5.minutes do
+      runner 'SidekiqMonitoring::Status.refresh'
+    end
+
+Be sure that your parent app provides HTTP basic authentication credentials and
+a redis connection via `Redis.current` or explicitly provide a redis URL using
+an initializer
+
+    # app/config/initializers/sidekiq_monitoring.rb
+    SidekiqMonitoring.redis_url = 'redis://127.0.0.1:6379/0' # optional
+    SidekiqMonitoring.http_auth_name = 'user'
+    SidekiqMonitoring.http_auth_password = 'password'
+
+This engine's controller inherits from `ApplicationController` by default. You
+can change this using the `parent_controller` option
+
+    SidekiqMonitoring.parent_controller = 'SomeOtherController'
+
+## Usage
+
+Navigate to `/sidekiq_monitoring/status` and receive Sidekiq status information:
+
+    {
+      "timestamps": {
+        "whenever_ran": "2018-01-23 15:05:02",
+        "sidekiq_performed": "2018-01-23 15:05:02",
+        "requested": "2018-01-23 15:08:28"
+      },
+      "sidekiq": {
+        "active_workers": 0,
+        "queue_sizes": {
+          "mailers": 0,
+          "default": 0,
+          "scheduled": 0,
+          "retries": 0,
+          "dead": 0
+        },
+        "recent_history": {
+          "processed": {
+            "2018-01-23": 18,
+            "2018-01-22": 0,
+            "2018-01-21": 0,
+            "2018-01-20": 0,
+            "2018-01-19": 0
+          },
+          "failed": {
+            "2018-01-23": 0,
+            "2018-01-22": 0,
+            "2018-01-21": 0,
+            "2018-01-20": 0,
+            "2018-01-19": 0
+          }
+        },
+        "totals": {
+          "processed": 18,
+          "failed": 0
+        }
+      }
+    }

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SidekiqMonitoring'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/sidekiq_monitoring/application_controller.rb

@@ -0,0 +1,5 @@
+module SidekiqMonitoring
+  class ApplicationController < SidekiqMonitoring.parent_controller.constantize
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/sidekiq_monitoring/status_controller.rb

@@ -0,0 +1,68 @@
+module SidekiqMonitoring
+  class StatusController < ApplicationController
+    http_basic_authenticate_with name:     SidekiqMonitoring.http_auth_name,
+                                 password: SidekiqMonitoring.http_auth_password
+
+    def status
+      render json: status_data
+    end
+
+    private
+
+    def status_data
+      {
+        timestamps: timestamps,
+        sidekiq: sidekiq_data
+      }
+    end
+
+    def timestamps
+      {
+        whenever_ran: Redis.current.get('monitoring:timestamp:whenever_ran'),
+        sidekiq_performed: Redis.current.get('monitoring:timestamp:sidekiq_performed'),
+        requested: Time.current.to_s(:db)
+      }
+    end
+
+    def sidekiq_data
+      {
+        active_workers: sidekiq_stats.workers_size,
+        queue_sizes: sidekiq_queue_sizes,
+        recent_history: recent_history,
+        totals: totals
+      }
+    end
+
+    def sidekiq_stats
+      @sidekiq_stats ||= Sidekiq::Stats.new
+    end
+
+    def sidekiq_history
+      @sidekiq_history ||= Sidekiq::Stats::History.new(5)
+    end
+
+    def recent_history
+      {
+        processed: sidekiq_history.processed,
+        failed: sidekiq_history.failed
+      }
+    end
+
+    def totals
+      {
+        processed: sidekiq_stats.processed,
+        failed: sidekiq_stats.failed
+      }
+    end
+
+    def sidekiq_queue_sizes
+      queue_sizes = sidekiq_stats.queues
+
+      queue_sizes.merge(
+        scheduled: sidekiq_stats.scheduled_size,
+        retries: sidekiq_stats.retry_size,
+        dead: sidekiq_stats.dead_size
+      )
+    end
+  end
+end

data/app/jobs/sidekiq_monitoring/application_job.rb

@@ -0,0 +1,4 @@
+module SidekiqMonitoring
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/jobs/sidekiq_monitoring/refresh_status_job.rb

@@ -0,0 +1,7 @@
+module SidekiqMonitoring
+  class RefreshStatusJob < ApplicationJob
+    def perform
+      Redis.current.set('monitoring:timestamp:sidekiq_performed', Time.current.to_s(:db))
+    end
+  end
+end

data/app/services/sidekiq_monitoring/status.rb

@@ -0,0 +1,8 @@
+module SidekiqMonitoring
+  class Status
+    def self.refresh
+      Redis.current.set('monitoring:timestamp:whenever_ran', Time.current.strftime('%Y-%m-%d %H:%M:%S'))
+      RefreshStatusJob.perform_later
+    end
+  end
+end

data/config/initializer/redis.rb

@@ -0,0 +1 @@
+Redis.current ||= Redis.new(SidekiqMonitoring.redis_url)

data/config/routes.rb

@@ -0,0 +1,5 @@
+SidekiqMonitoring::Engine.routes.draw do
+  controller :status do
+    get :status
+  end
+end

data/lib/sidekiq_monitoring/engine.rb

@@ -0,0 +1,9 @@
+require 'redis'
+require 'sidekiq'
+require 'sidekiq/api'
+
+module SidekiqMonitoring
+  class Engine < ::Rails::Engine
+    isolate_namespace SidekiqMonitoring
+  end
+end

data/lib/sidekiq_monitoring/version.rb

@@ -0,0 +1,3 @@
+module SidekiqMonitoring
+  VERSION = '0.1.0'.freeze
+end

data/lib/sidekiq_monitoring.rb

@@ -0,0 +1,12 @@
+require 'sidekiq_monitoring/engine'
+
+module SidekiqMonitoring
+  mattr_accessor :parent_controller
+  self.parent_controller = '::ApplicationController'
+
+  mattr_accessor :redis_url
+  self.redis_url = 'redis://127.0.0.1:6379/0'
+
+  mattr_accessor :http_auth_name
+  mattr_accessor :http_auth_password
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_monitoring_bitcrowd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julian Dobmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: redis
+  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: sidekiq
+  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: fakeredis
+  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: rubocop
+  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: rubocop-bitcrowd
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: |
+  Rails engine that provides a JSON API which serves Sidekiq
+  status information from a HTTP-auth protected endpoint.
+  This status information is gathered by scheduling a frequently
+  running job that saves timestamps in Redis.
+email:
+- julian@bitcrowd.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/controllers/sidekiq_monitoring/application_controller.rb
+- app/controllers/sidekiq_monitoring/status_controller.rb
+- app/jobs/sidekiq_monitoring/application_job.rb
+- app/jobs/sidekiq_monitoring/refresh_status_job.rb
+- app/services/sidekiq_monitoring/status.rb
+- config/initializer/redis.rb
+- config/routes.rb
+- lib/sidekiq_monitoring.rb
+- lib/sidekiq_monitoring/engine.rb
+- lib/sidekiq_monitoring/version.rb
+homepage: https://github.com/bitcrowd/sidekiq_monitoring
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Provide Sidekiq status information via JSON API.
+test_files: []