rails_autoscale_agent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e36ab348752b0f7b470a47224ccfb8b8375a2355
+  data.tar.gz: 14d64ad0ed2114955d34f2e9e5a129c763d5ffb3
+SHA512:
+  metadata.gz: d68ddb62be312c4afd8ee376c249f9755472c04a90cb8a98409a8b9e806dafaa3ea909c2ff06e2a42c6b48d466b1af1dca134640eef7db0ae67df79251d7017e
+  data.tar.gz: 59fb44914ffc29746221370e8cbaf3397b5adb725a474905d20fcd42e36172fe0aa7b9736e3f5b354c16e92915040f8238fad0abf8f166c28cac5084019464af

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_autoscale_agent.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Adam McCrea
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# 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,
+and periodically posts this data asynchronously to the Rails Autoscale service.
+
+## Requirements
+
+We've tested this with Rails versions 3.2 through 5.0 and Ruby versions 1.9.3 through 2.3.1.
+
+## Getting Started
+
+Add this line to your application's Gemfile and run `bundle`:
+
+```ruby
+gem 'rails_autoscale_agent'
+```
+
+This will automatically insert the agent into your Rack middleware stack.
+
+The agent will only communicate with Rails Autoscale if a `RAILS_AUTOSCALE_URL` ENV variable is present,
+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.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`,
+and then run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/adamlogic/rails_autoscale_agent.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_autoscale_agent"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/rails_autoscale_agent.rb

@@ -0,0 +1,5 @@
+module RailsAutoscaleAgent
+end
+
+require 'rails_autoscale_agent/version'
+require 'rails_autoscale_agent/railtie' if defined?(Rails::Railtie) && Rails::Railtie.respond_to?(:initializer)

data/lib/rails_autoscale_agent/autoscale_api.rb

@@ -0,0 +1,52 @@
+require 'net/http'
+require 'uri'
+require 'json'
+require 'rails_autoscale_agent/logger'
+
+module RailsAutoscaleAgent
+  class AutoscaleApi
+    include Logger
+
+    SUCCESS = 'success'
+
+    def initialize(api_url_base)
+      @api_url_base = api_url_base
+    end
+
+    def report_metrics!(report_params)
+      post '/reports', report: report_params
+    end
+
+    def register_reporter!(registration_params)
+      post '/registrations', registration: registration_params
+    end
+
+    private
+
+    def post(path, data)
+      header = {'Content-Type' => 'application/json'}
+      uri = URI.parse("#{@api_url_base}#{path}")
+      ssl = uri.scheme == 'https'
+
+      response = Net::HTTP.start(uri.host, uri.port, use_ssl: ssl) do |http|
+        request = Net::HTTP::Post.new(uri.request_uri, header)
+        request.body = JSON.dump(data)
+
+        logger.debug "[AutoscaleApi] Posting to #{request.body.size} bytes to #{uri}"
+        http.request(request)
+      end
+
+      case response.code.to_i
+      when 200...300 then SuccessResponse.new
+      else FailureResponse.new(response.message)
+      end
+    end
+
+    class SuccessResponse
+    end
+
+    class FailureResponse < Struct.new(:failure_message)
+    end
+
+  end
+end

data/lib/rails_autoscale_agent/collector.rb

@@ -0,0 +1,23 @@
+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.debug "[Collector] request queued for more than 10 minutes... skipping collection"
+        else
+          queue_time_millis = (Time.now - request.entered_queue_at) * 1000
+          queue_time_millis = 0 if queue_time_millis < 0
+          store.push(queue_time_millis)
+        end
+      else
+        logger.debug "[Collector] no wait time data to collect"
+      end
+    end
+
+  end
+end

data/lib/rails_autoscale_agent/config.rb

@@ -0,0 +1,22 @@
+module RailsAutoscaleAgent
+  class Config
+    attr_reader :api_base_url, :dyno, :pid, :fake_mode
+    alias_method :fake_mode?, :fake_mode
+
+    def initialize(environment)
+      @api_base_url = environment['RAILS_AUTOSCALE_URL']
+      @pid = Process.pid
+      @fake_mode = true if environment['RAILS_AUTOSCALE_FAKE_MODE'] == 'true'
+
+      if fake_mode?
+        @dyno = 'web.123'
+      else
+        @dyno = environment['DYNO']
+      end
+    end
+
+    def to_s
+      "#{@dyno}-#{@pid}"
+    end
+  end
+end

data/lib/rails_autoscale_agent/logger.rb

@@ -0,0 +1,9 @@
+module RailsAutoscaleAgent
+  module Logger
+
+    def logger
+      @logger ||= Rails.logger
+    end
+
+  end
+end

data/lib/rails_autoscale_agent/measurement.rb

@@ -0,0 +1,7 @@
+module RailsAutoscaleAgent
+  class Measurement < Struct.new(:time, :value)
+    def initialize(time, value)
+      super time.utc, value.to_i
+    end
+  end
+end

data/lib/rails_autoscale_agent/middleware.rb

@@ -0,0 +1,37 @@
+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'
+
+module RailsAutoscaleAgent
+  class Middleware
+    include Logger
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      config = Config.new(ENV)
+
+      logger.tagged 'RailsAutoscaleAgent', config.to_s do
+        if config.api_base_url
+          request = Request.new(env, config)
+
+          logger.debug "[Middleware] enter middleware for #{request.fullpath}"
+
+          store = Store.instance
+          Reporter.start(config, store)
+          Collector.collect(request, store)
+        else
+          logger.info "[Middleware] RAILS_AUTOSCALE_URL is not set"
+        end
+      end
+
+      @app.call(env)
+    end
+
+  end
+end

data/lib/rails_autoscale_agent/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails_autoscale_agent/middleware'
+
+module RailsAutoscaleAgent
+  class Railtie < Rails::Railtie
+    initializer "rails_autoscale_agent.middleware" do |app|
+      app.middleware.insert_before Rack::Runtime, Middleware
+    end
+  end
+end

data/lib/rails_autoscale_agent/registration.rb

@@ -0,0 +1,15 @@
+require 'rails_autoscale_agent/version'
+
+module RailsAutoscaleAgent
+  class Registration < Struct.new(:config)
+
+    def to_params
+      {
+        pid: Process.pid,
+        ruby_version: RUBY_VERSION,
+        rails_version: Rails.version,
+        gem_version: VERSION,
+      }
+    end
+  end
+end

data/lib/rails_autoscale_agent/report.rb

@@ -0,0 +1,17 @@
+module RailsAutoscaleAgent
+  class Report < Struct.new(:time, :values)
+
+    def initialize(time, values = [])
+      super
+    end
+
+    def to_params(config)
+      {
+        time: time.iso8601,
+        dyno: config.dyno,
+        pid: config.pid,
+        measurements: values,
+      }
+    end
+  end
+end

data/lib/rails_autoscale_agent/reporter.rb

@@ -0,0 +1,78 @@
+require 'singleton'
+require 'rails_autoscale_agent/logger'
+require 'rails_autoscale_agent/autoscale_api'
+require 'rails_autoscale_agent/time_rounder'
+require 'rails_autoscale_agent/registration'
+
+# Reporter wakes up every minute to send metrics to the RailsAutoscale API
+
+module RailsAutoscaleAgent
+  class Reporter
+    include Singleton
+    include Logger
+
+    def self.start(config, store)
+      instance.start!(config, store) unless instance.running?
+    end
+
+    def start!(config, store)
+      logger.info "[Reporter] starting reporter, will report every minute"
+
+      @running = true
+
+      Thread.new do
+        register!(config)
+
+        loop do
+          beginning_of_next_minute = TimeRounder.beginning_of_minute(Time.now) + 60
+
+          # add 0-5 seconds to avoid slamming the API at one moment
+          next_report_time = beginning_of_next_minute + rand * 5
+
+          sleep next_report_time - Time.now
+
+          begin
+            report!(config, store)
+          rescue => ex
+            # Exceptions in threads other than the main thread will fail silently
+            # https://ruby-doc.org/core-2.2.0/Thread.html#class-Thread-label-Exception+handling
+            logger.error "[Reporter] #{ex.inspect}"
+            logger.error ex.backtrace.join("\n")
+          end
+        end
+      end
+    end
+
+    def running?
+      @running
+    end
+
+    def report!(config, store)
+      while report = store.pop_report
+        logger.info "[Reporter] reporting queue times for #{report.values.size} requests during minute #{report.time.iso8601}"
+
+        params = report.to_params(config)
+        result = AutoscaleApi.new(config.api_base_url).report_metrics!(params)
+
+        case result
+        when AutoscaleApi::SuccessResponse
+          logger.info "[Reporter] reported successfully"
+        when AutoscaleApi::FailureResponse
+          logger.error "[Reporter] failed: #{result.failure_message}"
+        end
+      end
+
+      logger.debug "[Reporter] nothing to report" unless result
+    end
+
+    def register!(config)
+      params = Registration.new(config).to_params
+      result = AutoscaleApi.new(config.api_base_url).register_reporter!(params)
+
+      if result.is_a? AutoscaleApi::FailureResponse
+        logger.error "[Reporter] failed to register: #{result.failure_message}"
+      end
+    end
+
+  end
+end

data/lib/rails_autoscale_agent/request.rb

@@ -0,0 +1,14 @@
+module RailsAutoscaleAgent
+  class Request
+    attr_reader :entered_queue_at, :fullpath
+
+    def initialize(env, config)
+      @fullpath = "#{env['HTTP_HOST']}#{env['PATH_INFO']}"
+      @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
+    end
+  end
+end

data/lib/rails_autoscale_agent/store.rb

@@ -0,0 +1,41 @@
+require 'singleton'
+require 'rails_autoscale_agent/logger'
+require 'rails_autoscale_agent/time_rounder'
+require 'rails_autoscale_agent/measurement'
+require 'rails_autoscale_agent/report'
+
+module RailsAutoscaleAgent
+  class Store
+    include Singleton
+    include Logger
+
+    def initialize
+      @measurements = []
+    end
+
+    def push(value, time = Time.now)
+      logger.debug "[Collector] queue time: #{value}"
+      @measurements << Measurement.new(time, value)
+    end
+
+    def pop_report
+      result = nil
+      boundary = TimeRounder.beginning_of_minute(Time.now)
+
+      while @measurements[0] && @measurements[0].time < boundary
+        measurement = @measurements.shift
+
+        if result.nil?
+          report_time = TimeRounder.beginning_of_minute(measurement.time)
+          boundary = report_time + 60
+          result = Report.new(report_time)
+        end
+
+        result.values << measurement.value
+      end
+
+      result
+    end
+
+  end
+end

data/lib/rails_autoscale_agent/time_rounder.rb

@@ -0,0 +1,17 @@
+module RailsAutoscaleAgent
+  class TimeRounder
+
+    def self.beginning_of_minute(time)
+      Time.new(
+        time.year,
+        time.month,
+        time.day,
+        time.hour,
+        time.min,
+        0,
+        time.utc_offset
+      )
+    end
+
+  end
+end

data/lib/rails_autoscale_agent/version.rb

@@ -0,0 +1,3 @@
+module RailsAutoscaleAgent
+  VERSION = "0.1.0"
+end

data/rails_autoscale_agent.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_autoscale_agent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_autoscale_agent"
+  spec.version       = RailsAutoscaleAgent::VERSION
+  spec.authors       = ["Adam McCrea"]
+  spec.email         = ["adam@adamlogic.com"]
+
+  spec.summary       = "This gem works with the Rails Autoscale Heroku add-on to automatically scale your web dynos."
+  spec.homepage      = "https://github.com/adamlogic/rails_autoscale_agent"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: rails_autoscale_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam McCrea
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: vcr
+  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: webmock
+  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: 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: pry-byebug
+  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: 
+email:
+- adam@adamlogic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- 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
+- lib/rails_autoscale_agent/middleware.rb
+- lib/rails_autoscale_agent/railtie.rb
+- lib/rails_autoscale_agent/registration.rb
+- lib/rails_autoscale_agent/report.rb
+- lib/rails_autoscale_agent/reporter.rb
+- lib/rails_autoscale_agent/request.rb
+- lib/rails_autoscale_agent/store.rb
+- lib/rails_autoscale_agent/time_rounder.rb
+- lib/rails_autoscale_agent/version.rb
+- rails_autoscale_agent.gemspec
+homepage: https://github.com/adamlogic/rails_autoscale_agent
+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.5.1
+signing_key: 
+specification_version: 4
+summary: This gem works with the Rails Autoscale Heroku add-on to automatically scale
+  your web dynos.
+test_files: []