rails_autoscale_agent 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 98ed2f90f2585a2e0ef2708353fcd3781bdee1fb
-  data.tar.gz: 8111cdfd58133de98690a2e431c9b3c22d0eb7d7
+SHA256:
+  metadata.gz: 835d9318705ae0bab9644578e6e39f6b29dd9c36d50671cf8651e44bfcfe2af5
+  data.tar.gz: c205493eb704e12e8d7da388de903e9391dfa328636118021ff5f4ca4173b127
 SHA512:
-  metadata.gz: 98634e7e2182246c3564b37e2ef71c94c19e45d7deb7f67e3ce1099469ea6b4fc2de006be378c0e9730520466846349f88e5e44b1bedf335985ea113e37f80bb
-  data.tar.gz: ecf32db52d110100e7146725e3481e3e43d62e13de65adea74a9391c26fc8755eda855ffe3990ef1fee0de2464a777e068d59dbc37ac897094cce5a8ec9f027f
+  metadata.gz: 7fe642672aa559193cd48ca32ade1acdabc3c176d8a9435b4964bb0db86752fdd2aae9ed1698d75570c015b44a87d0b6dd895925cadc831a2f4628f4c9a5efe8
+  data.tar.gz: f55a4a48fe981add95eb0ad497bc7d389841e0d2c9254a63b4378284f2bd14ae364b0b3a5e468783b23f453d31c34e84f716f1d27fbde56ec8c3c7f8a4d4d1c4

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/.travis.yml

@@ -1,5 +1,3 @@
-sudo: false
 language: ruby
 rvm:
-  - 2.3.1
-before_install: gem install bundler -v 1.12.5
+  - 2.5.0

data/README.md

@@ -1,5 +1,7 @@
 # Rails Autoscale Agent
 
+[![Build Status](https://travis-ci.org/adamlogic/rails_autoscale_agent.svg?branch=master)](https://travis-ci.org/adamlogic/rails_autoscale_agent)
+
 This gem works together with the Rails Autoscale Heroku add-on
 to automatically scale your web dynos as needed.
 It gathers a minimal set of metrics for each request,
@@ -24,6 +26,19 @@ which happens automatically when you install the Heroku add-on.
 In development (or anytime the ENV var is missing), the middleware will still produce
 `INFO`-level log output to your Rails log.
 
+## Non-Rails Rack apps
+
+You'll need to insert the `RailsAutoscaleAgent::Middleware` manually. Insert it
+before `Rack::Runtime` to ensure accuracy of request queue timings.
+
+## Changing the logger
+
+If you wish to use a different logger you can set it on the configuration object:
+
+```ruby
+RailsAutoscaleAgent::Config.instance.logger = MyLogger.new
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
@@ -42,4 +57,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/adamlo
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/lib/rails_autoscale_agent.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAutoscaleAgent
 end
 

data/lib/rails_autoscale_agent/autoscale_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'uri'
 require 'json'

data/lib/rails_autoscale_agent/config.rb

@@ -1,25 +1,21 @@
+# frozen_string_literal: true
+
 require 'singleton'
 
 module RailsAutoscaleAgent
   class Config
     include Singleton
 
-    attr_reader :api_base_url, :dyno, :pid, :fake_mode, :max_request_size
-    attr_accessor :report_interval
-    alias_method :fake_mode?, :fake_mode
+    attr_accessor :report_interval, :logger, :api_base_url, :max_request_size,
+                  :dyno, :pid
 
     def initialize
       @api_base_url = ENV['RAILS_AUTOSCALE_URL']
       @pid = Process.pid
       @max_request_size = 100_000 # ignore request payloads over 100k since they skew the queue times
       @report_interval = 60 # this default will be overwritten during Reporter#register!
-      @fake_mode = true if ENV['RAILS_AUTOSCALE_FAKE_MODE'] == 'true'
-
-      if fake_mode?
-        @dyno = 'web.123'
-      else
-        @dyno = ENV['DYNO']
-      end
+      @logger ||= defined?(Rails) ? Rails.logger : ::Logger.new(STDOUT)
+      @dyno = ENV['DYNO']
     end
 
     def to_s
@@ -27,7 +23,7 @@ module RailsAutoscaleAgent
     end
 
     def ignore_large_requests?
-      @max_request_size.present?
+      @max_request_size
     end
 
   end

data/lib/rails_autoscale_agent/logger.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module RailsAutoscaleAgent
   module Logger
 
     def logger
-      @logger ||= Rails.logger
+      @logger ||= Config.instance.logger
     end
 
   end

data/lib/rails_autoscale_agent/measurement.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAutoscaleAgent
   class Measurement < Struct.new(:time, :value)
     def initialize(time, value)

data/lib/rails_autoscale_agent/middleware.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 require 'rails_autoscale_agent/logger'
 require 'rails_autoscale_agent/store'
-require 'rails_autoscale_agent/collector'
 require 'rails_autoscale_agent/reporter'
 require 'rails_autoscale_agent/config'
 require 'rails_autoscale_agent/request'
@@ -22,7 +23,12 @@ module RailsAutoscaleAgent
 
         store = Store.instance
         Reporter.start(config, store)
-        Collector.collect(request, store) unless request.ignore?
+
+        if !request.ignore? && queue_time = request.queue_time
+          # NOTE: Expose queue time to the app
+          env['queue_time'] = queue_time
+          store.push queue_time
+        end
       end
 
       @app.call(env)

data/lib/rails_autoscale_agent/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_autoscale_agent/middleware'
 
 module RailsAutoscaleAgent

data/lib/rails_autoscale_agent/registration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_autoscale_agent/version'
 
 module RailsAutoscaleAgent
@@ -8,7 +10,7 @@ module RailsAutoscaleAgent
         dyno: config.dyno,
         pid: config.pid,
         ruby_version: RUBY_VERSION,
-        rails_version: Rails.version,
+        rails_version: defined?(Rails) && Rails.version,
         gem_version: VERSION,
       }
     end

data/lib/rails_autoscale_agent/report.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAutoscaleAgent
   class Report
 
@@ -15,12 +17,12 @@ module RailsAutoscaleAgent
     end
 
     def to_csv
-      ''.tap do |result|
+      String.new.tap do |result|
         @measurements.each do |measurement|
           result << measurement.time.to_i.to_s
-          result << ','.freeze
+          result << ','
           result << measurement.value.to_s
-          result << "\n".freeze
+          result << "\n"
         end
       end
     end

data/lib/rails_autoscale_agent/reporter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 require 'rails_autoscale_agent/logger'
 require 'rails_autoscale_agent/autoscale_api'

data/lib/rails_autoscale_agent/request.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 module RailsAutoscaleAgent
   class Request
+    include Logger
+    
     attr_reader :id, :entered_queue_at, :path, :method, :size
 
     def initialize(env, config)
@@ -8,16 +12,29 @@ module RailsAutoscaleAgent
       @path = env['PATH_INFO']
       @method = env['REQUEST_METHOD'].downcase
       @size = env['rack.input'].respond_to?(:size) ? env['rack.input'].size : 0
-      @entered_queue_at = if unix_millis = env['HTTP_X_REQUEST_START']
-                            Time.at(unix_millis.to_f / 1000)
-                          elsif config.fake_mode?
-                            Time.now - rand(1000) / 1000.0 # 0-1000 ms ago
-                          end
+
+      if unix_millis = env['HTTP_X_REQUEST_START']
+        @entered_queue_at = Time.at(unix_millis.to_f / 1000)
+      end
     end
 
     def ignore?
       @config.ignore_large_requests? && @size > @config.max_request_size
     end
 
+    def queue_time
+      if entered_queue_at
+        if entered_queue_at < (Time.now - 60 * 10)
+          # ignore unreasonable values
+          logger.info "request queued for more than 10 minutes... skipping collection"
+        else
+          queue_time = ((Time.now - entered_queue_at) * 1000).to_i
+          queue_time = 0 if queue_time < 0
+          logger.info "Collected queue_time=#{queue_time}ms request_id=#{id} request_size=#{size}"
+
+          queue_time
+        end
+      end
+    end
   end
 end

data/lib/rails_autoscale_agent/store.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 require 'rails_autoscale_agent/time_rounder'
 require 'rails_autoscale_agent/measurement'

data/lib/rails_autoscale_agent/time_rounder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAutoscaleAgent
   class TimeRounder
 

data/lib/rails_autoscale_agent/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAutoscaleAgent
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_autoscale_agent
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Adam McCrea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-26 00:00:00.000000000 Z
+date: 2018-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -131,6 +131,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -140,7 +141,6 @@ files:
 - bin/setup
 - lib/rails_autoscale_agent.rb
 - lib/rails_autoscale_agent/autoscale_api.rb
-- lib/rails_autoscale_agent/collector.rb
 - lib/rails_autoscale_agent/config.rb
 - lib/rails_autoscale_agent/logger.rb
 - lib/rails_autoscale_agent/measurement.rb
@@ -153,6 +153,7 @@ files:
 - lib/rails_autoscale_agent/store.rb
 - lib/rails_autoscale_agent/time_rounder.rb
 - lib/rails_autoscale_agent/version.rb
+- log/.gitkeep
 - rails_autoscale_agent.gemspec
 homepage: https://github.com/adamlogic/rails_autoscale_agent
 licenses:
@@ -174,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: This gem works with the Rails Autoscale Heroku add-on to automatically scale

data/lib/rails_autoscale_agent/collector.rb

@@ -1,22 +0,0 @@
-require 'rails_autoscale_agent/logger'
-
-module RailsAutoscaleAgent
-  class Collector
-    extend Logger
-
-    def self.collect(request, store)
-      if request.entered_queue_at
-        if request.entered_queue_at < (Time.now - 60 * 10)
-          # ignore unreasonable values
-          logger.info "request queued for more than 10 minutes... skipping collection"
-        else
-          queue_time_millis = ((Time.now - request.entered_queue_at) * 1000).to_i
-          queue_time_millis = 0 if queue_time_millis < 0
-          store.push(queue_time_millis)
-          logger.info "Collected queue_time=#{queue_time_millis}ms request_id=#{request.id}"
-        end
-      end
-    end
-
-  end
-end