rain_catcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 21d83997891c531894ed0950c5d677d327f0cb3e8c38e594c691b6982e1a58b8
+  data.tar.gz: 404ae934f248a392261b66a8d8a9bea24542e34299a1007cfe1e0f1d3e8bd2e5
+SHA512:
+  metadata.gz: b8f8581204db2aa49eb41dee8d27e809e8194999173a2f26d5b77048232c2a226d24e24167ff0fbf001d82e0ee00bc14ef18e34ac09aa1a7a4c1b5a084205d77
+  data.tar.gz: 84bef156e860e96c468017f4bae93c6b35dff7c3a3b51027ad4b6738ad67233b3655bb4dad5f080d4a1a07f7311cdb82fc8a3ac0065c59f88fcf5c46da452751

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# vim artefacts
+*.swo
+*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rain_catcher.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    rain_catcher (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    paint (2.1.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.69.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.0)
+    strong_versions (0.3.2)
+      i18n (>= 0.5.0)
+      paint (~> 2.0)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rain_catcher!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+  strong_versions
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,27 @@
+# RainCatcher
+
+_RainCatcher_ utilises the [raindrops](https://bogomips.org/raindrops/) statistics tool to automatically log _Rack_ web server queue data for _Rails_ applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rain_catcher', '~> 0.1.0'
+```
+
+And rebuild your bundle:
+```
+bundle install
+```
+
+## Usage
+
+_RainCatcher_ automatically adds a hook into all web requests made to your application controller which will make a new log entry _not more frequently than_ a predetermined interval.
+
+When each request is processed, if the configured interval has elapsed then a log entry will be made.
+
+| Variable | Default Value | Meaning |
+|-|-|-|
+| `RAIN_CATCHER_LOG_INTERVAL` | 30 | Minimum number of seconds between each log entry |
+| `RAIN_CATCHER_LOG_LEVEL` | INFO | Log level to use for log entries |

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rain_catcher"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rain_catcher.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rain_catcher/version'
+require 'rain_catcher/railtie'
+
+module RainCatcher
+  class Error < StandardError; end
+end

data/lib/rain_catcher/railtie.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RainCatcher
+  class Railtie < Rails::Railtie
+    initializer :rain_catcher do
+      notifications.subscribe('process_action.action_controller') do |_args|
+        log_if_interval_elapsed
+      end
+    end
+
+    private
+
+    def notifications
+      ActiveSupport::Notifications
+    end
+
+    def log_if_interval_elapsed
+      return unless elapsed?
+
+      Rails.logger.send(level, queue_data.to_json)
+      @last_logged = Time.now.utc
+    end
+
+    def queue_data
+      Raindrops::ListenStats.new(0, 0).to_h.merge(source: 'rain_catcher')
+    end
+
+    def elapsed?
+      return true if @last_logged.nil?
+      return true if (Time.now.utc - @last_logged).seconds >= interval
+
+      false
+    end
+
+    def interval
+      @interval ||= ENV.fetch('RAIN_CATCHER_LOG_INTERVAL', '30').to_i
+    end
+
+    def level
+      @level ||= ENV.fetch('RAIN_CATCHER_LOG_LEVEL', 'INFO').downcase.to_sym
+    end
+  end
+end

data/lib/rain_catcher/version.rb

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

data/rain_catcher.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rain_catcher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rain_catcher'
+  spec.version       = RainCatcher::VERSION
+  spec.authors       = ['Bob Farrell']
+  spec.email         = ['robertanthonyfarrell@gmail.com']
+
+  spec.summary       = 'Automatically log Raindrops statistics'
+  spec.description   = 'Rails application statistic logging with Raindrops'
+  spec.homepage      = 'https://github.com/bobf/rain_catcher'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'strong_versions'
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: rain_catcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bob Farrell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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: strong_versions
+  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 application statistic logging with Raindrops
+email:
+- robertanthonyfarrell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rain_catcher.rb
+- lib/rain_catcher/railtie.rb
+- lib/rain_catcher/version.rb
+- rain_catcher.gemspec
+homepage: https://github.com/bobf/rain_catcher
+licenses: []
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Automatically log Raindrops statistics
+test_files: []