rails_autoscale_agent 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 835d9318705ae0bab9644578e6e39f6b29dd9c36d50671cf8651e44bfcfe2af5
-  data.tar.gz: c205493eb704e12e8d7da388de903e9391dfa328636118021ff5f4ca4173b127
+  metadata.gz: 9599e5eb723b8e92f13eb6f820ce7f49f6af5ae946146eb140f13e42a465625a
+  data.tar.gz: 94eeec3ac6376605b5d0db1c8aa406c1f7101fddbf2f188e1cbb41c5f2f836bc
 SHA512:
-  metadata.gz: 7fe642672aa559193cd48ca32ade1acdabc3c176d8a9435b4964bb0db86752fdd2aae9ed1698d75570c015b44a87d0b6dd895925cadc831a2f4628f4c9a5efe8
-  data.tar.gz: f55a4a48fe981add95eb0ad497bc7d389841e0d2c9254a63b4378284f2bd14ae364b0b3a5e468783b23f453d31c34e84f716f1d27fbde56ec8c3c7f8a4d4d1c4
+  metadata.gz: c8d33309ab62d23341bc707e8b5e5da5158e21885911fd0418a58c5880b4fe24a309cabf3cd08513382e18570e7c28f8ff2fa1bb7362f040aac8f3210fdf306e
+  data.tar.gz: 41999dbec255f00d7f3369f97e81acae12c556b126050ea28a50816a8c91801a8dfa256cdfc14f8126c4ad175ecd9dc16fd3b8136aaf0c9805301a362cdf81de

data/README.md

@@ -2,14 +2,11 @@
 
 [![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,
-and periodically posts this data asynchronously to the Rails Autoscale service.
+This gem works together with the [Rails Autoscale](https://railsautoscale.com) 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 and higher and Ruby versions 1.9.3 and higher.
+Tested with Rails versions 3.2 and higher and Ruby versions 1.9.3 and higher.
 
 ## Getting Started
 
@@ -19,17 +16,13 @@ Add this line to your application's Gemfile and run `bundle`:
 gem 'rails_autoscale_agent'
 ```
 
-This will automatically insert the agent into your Rack middleware stack.
+This inserts 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.
+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. The middleware does nothing if `RAILS_AUTOSCALE_URL` is not present, such as in development or a staging app.
 
 ## 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.
+You'll need to insert the `RailsAutoscaleAgent::Middleware` manually. Insert it before `Rack::Runtime` to ensure accuracy of request queue timings.
 
 ## Changing the logger
 
@@ -39,16 +32,40 @@ If you wish to use a different logger you can set it on the configuration object
 RailsAutoscaleAgent::Config.instance.logger = MyLogger.new
 ```
 
+## What data is collected?
+
+The middleware agent runs in its own thread so your web requests are not impacted. The following data is submitted periodically to the Rails Autoscale API:
+
+- Ruby version
+- Rails version
+- Gem version
+- Dyno name (example: web.1)
+- PID
+- Collection of queue time measurements (time and milliseconds)
+
+Rails Autoscale processes and stores this information in order to power the autoscaling algorithm and dashboard visualizations.
+
+## Troubleshooting
+
+If your logger supports tagged logging (as the Rails logger does by default), all log output from this gem is prefixed with "[RailsAutoscale]".
+
+Once installed, you should see something like this in development:
+
+> [RailsAutoscale] Reporter not started: RAILS_AUTOSCALE_URL is not set
+
+In production, you should see something like this:
+
+> [RailsAutoscale] Reporter starting, will report every 15 seconds
+
+If you don't see either of these, try running `bundle` again and restarting your Rails application.
+
+Reach out to help@railsautoscale.com if you run into any other problems.
+
 ## 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.
+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).
+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
 

data/lib/rails_autoscale_agent/logger.rb

@@ -2,10 +2,17 @@
 
 module RailsAutoscaleAgent
   module Logger
-
     def logger
-      @logger ||= Config.instance.logger
+      @logger ||= Config.instance.logger.tap do |logger|
+        logger.extend(FakeTaggedLogging) unless logger.respond_to?(:tagged)
+      end
     end
 
+    module FakeTaggedLogging
+      def tagged(*tags)
+        # NOTE: Quack like ActiveSupport::TaggedLogging, but don't reimplement
+        yield self
+      end
+    end
   end
 end

data/lib/rails_autoscale_agent/reporter.rb

@@ -59,7 +59,7 @@ module RailsAutoscaleAgent
 
         case result
         when AutoscaleApi::SuccessResponse
-          logger.info "Reported successfully"
+          logger.debug "Reported successfully"
         when AutoscaleApi::FailureResponse
           logger.error "Reporter failed: #{result.failure_message}"
         end

data/lib/rails_autoscale_agent/request.rb

@@ -3,7 +3,7 @@
 module RailsAutoscaleAgent
   class Request
     include Logger
-    
+
     attr_reader :id, :entered_queue_at, :path, :method, :size
 
     def initialize(env, config)
@@ -26,11 +26,11 @@ module RailsAutoscaleAgent
       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"
+          logger.warn "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}"
+          logger.debug "Collected queue_time=#{queue_time}ms request_id=#{id} request_size=#{size}"
 
           queue_time
         end

data/lib/rails_autoscale_agent/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_autoscale_agent
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Adam McCrea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
+date: 2019-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport