rails-monitoring 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e272c26624859b7d257917d9009e8d45e1d263f
+  data.tar.gz: f1cd488fff890a489f480d44237c9ed538c9f2c5
+SHA512:
+  metadata.gz: 13a8655264c6ed5f5b3f1c12b9612aabed4113e5026012889709249b2168856fa95c991eb32068eb87d7a05f439aa617d7590a35c4849652fc2bfce671334e3b
+  data.tar.gz: 7e8898ec1768c3d8030e706a60a6f28387ec9c16054c543289a342c2d1312cdd6d6a8cc4adb1ce9c95a8ca27c19acfd25be9d6d4a48f9ee0c522817de406f5bf

data/README.md

@@ -0,0 +1,87 @@
+# rails-monitoring[![Build Status](https://travis-ci.org/bitcrowd/rails-monitoring.svg?branch=master)](https://travis-ci.org/bitcrowd/rails-monitoring)
+
+Rails engine that provides a JSON API which serves Sidekiq and Whenever
+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:
+
+```ruby
+gem 'rails-monitoring'
+```
+
+Mount engine in `routes.rb`:
+```ruby
+Rails.application.routes.draw do
+  mount Rails::Monitoring::Engine => '/monitoring'
+end
+```
+
+Schedule job in `whenever`'s `schedule.rb`:
+
+```ruby
+every 5.minutes do
+  runner 'Rails::Monitoring::Status.refresh'
+end
+```
+
+Be sure that your parent app provides HTTP basic authentication credentials
+using an initializer
+
+```ruby
+# app/config/initializers/monitoring.rb
+Rails::Monitoring.http_auth_name = 'user'
+Rails::Monitoring.http_auth_password = 'password'
+```
+
+This engine's controller inherits from `ApplicationController` by default. You
+can change this using the `parent_controller` option
+
+```ruby
+Rails::Monitoring.parent_controller = 'SomeOtherController'
+```
+
+## Usage
+
+Navigate to `/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    = 'Rails::Monitoring'
+  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/rails/monitoring/application_controller.rb

@@ -0,0 +1,7 @@
+module Rails
+  module Monitoring
+    class ApplicationController < Rails::Monitoring.parent_controller.constantize
+      protect_from_forgery with: :exception
+    end
+  end
+end

data/app/controllers/rails/monitoring/status_controller.rb

@@ -0,0 +1,72 @@
+module Rails
+  module Monitoring
+    class StatusController < ApplicationController
+      http_basic_authenticate_with name:     Rails::Monitoring.http_auth_name,
+                                   password: Rails::Monitoring.http_auth_password
+
+      def status
+        render json: status_data
+      end
+
+      private
+
+      def status_data
+        {
+          timestamps: timestamps,
+          sidekiq: sidekiq_data
+        }
+      end
+
+      def timestamps
+        Sidekiq.redis do |conn|
+          {
+            whenever_ran: conn.get('monitoring:timestamp:whenever_ran'),
+            sidekiq_performed: conn.get('monitoring:timestamp:sidekiq_performed'),
+            requested: Time.current.to_s(:db)
+          }
+        end
+      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
+end

data/app/jobs/rails/monitoring/application_job.rb

@@ -0,0 +1,6 @@
+module Rails
+  module Monitoring
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/jobs/rails/monitoring/refresh_status_job.rb

@@ -0,0 +1,11 @@
+module Rails
+  module Monitoring
+    class RefreshStatusJob < ApplicationJob
+      def perform
+        Sidekiq.redis do |conn|
+          conn.set('monitoring:timestamp:sidekiq_performed', Time.current.to_s(:db))
+        end
+      end
+    end
+  end
+end

data/app/services/rails/monitoring/status.rb

@@ -0,0 +1,12 @@
+module Rails
+  module Monitoring
+    class Status
+      def self.refresh
+        Sidekiq.redis do |conn|
+          conn.set('monitoring:timestamp:whenever_ran', Time.current.to_s(:db))
+        end
+        RefreshStatusJob.perform_later
+      end
+    end
+  end
+end

data/config/routes.rb

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

data/lib/rails/monitoring.rb

@@ -0,0 +1,11 @@
+require 'rails/monitoring/engine'
+
+module Rails
+  module Monitoring
+    mattr_accessor :parent_controller
+    self.parent_controller = '::ApplicationController'
+
+    mattr_accessor :http_auth_name
+    mattr_accessor :http_auth_password
+  end
+end

data/lib/rails/monitoring/engine.rb

@@ -0,0 +1,10 @@
+require 'sidekiq'
+require 'sidekiq/api'
+
+module Rails
+  module Monitoring
+    class Engine < ::Rails::Engine
+      isolate_namespace Rails::Monitoring
+    end
+  end
+end

data/lib/rails/monitoring/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module Monitoring
+    VERSION = '0.2.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: rails-monitoring
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Julian Dobmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-02 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: 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: minitest-around
+  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 and Whenever
+  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/rails/monitoring/application_controller.rb
+- app/controllers/rails/monitoring/status_controller.rb
+- app/jobs/rails/monitoring/application_job.rb
+- app/jobs/rails/monitoring/refresh_status_job.rb
+- app/services/rails/monitoring/status.rb
+- config/routes.rb
+- lib/rails/monitoring.rb
+- lib/rails/monitoring/engine.rb
+- lib/rails/monitoring/version.rb
+homepage: https://github.com/bitcrowd/rails-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 Rails status information via JSON API.
+test_files: []