rails_autoscale_agent 0.9.0.beta.5 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f151c5012b2d2a5bb76f17ed4b4ee7f8f751ef9657c7f4b9d42d4d86fda7c654
-  data.tar.gz: 4773c138b97d723aa44f803ccb504facdf4c619995122296561933b5363d8910
+  metadata.gz: cd7ffb8cd27de3a23d5e76bd9a9c7768ce1fd397389291285022523fb398ee45
+  data.tar.gz: d8cf3fa7ab2994ef196742fe872170c069dc6f14bc0490b595ff175e48ce59e6
 SHA512:
-  metadata.gz: 432f9ea93f5c722f286a0bec54f22c477583f0b0501cff64498f2d710fdd5e3f674753443d017ab43cefc04d0b8b2263227554992e84f023b13074392d004e15
-  data.tar.gz: 1ba59eb800d04044e78e2c5462fe373dc4d81e1b14de72d4a41f3454acf4a4a0739067f8371ad2d31372badf2c222dffc0b13c2ef0c01e542d12d218a6c1981f
+  metadata.gz: '0976e83784dd6a622b18a67491e727cbe9f0fb1a54e1974f50b61f441f642a296b5a4e3349e2f4d292acc35c844765527c16e097cf7ac914a7224b68e2ae8bd6'
+  data.tar.gz: 2de7d8a61d44fd408cfbab88b1be37327bd5836da8c125f4c61f80ac7503c0a44c5ee5f893919eb5487e4a34a817102a68aabd76699d34d6ce3086680b8aceb7

data/README.md

@@ -24,16 +24,6 @@ The agent will only communicate with Rails Autoscale if a `RAILS_AUTOSCALE_URL`
 
 You'll need to insert the `RailsAutoscaleAgent::Middleware` manually. Insert it before `Rack::Runtime` to ensure accuracy of request queue timings.
 
-## Changing the logger
-
-The Rails logger is used by default.
-If you wish to use a different logger you can set it on the configuration object:
-
-```ruby
-# config/initializers/rails_autoscale_agent.rb
-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:
@@ -59,17 +49,39 @@ In production, run `heroku logs -t | grep RailsAutoscale`, and you should see so
 
 If you don't see either of these, try running `bundle` again and restarting your Rails application.
 
-You can see more detailed (debug) logging by setting the `RAILS_AUTOSCALE_DEBUG` env var on your Heroku app:
+You can see more detailed (debug) logging by setting `RAILS_AUTOSCALE_DEBUG` on your Heroku app:
 
 ```
 heroku config:add RAILS_AUTOSCALE_DEBUG=true
 ```
 
-Debug logs are silenced by default because Rails apps default to a DEBUG log level in production,
-and these can get very noisy with this gem.
+See more in the [logging](#logging) section below.
 
 Reach out to help@railsautoscale.com if you run into any other problems.
 
+## Logging
+
+The Rails logger is used by default.
+If you wish to use a different logger you can set it on the configuration object:
+
+```ruby
+# config/initializers/rails_autoscale_agent.rb
+RailsAutoscaleAgent::Config.instance.logger = MyLogger.new
+```
+
+Debug logs are silenced by default because Rails apps default to a DEBUG log level in production, and this gem has _very_ chatty debug logs. If you want to see the debug logs, set `RAILS_AUTOSCALE_DEBUG` on your Heroku app:
+
+```
+heroku config:add RAILS_AUTOSCALE_DEBUG=true
+```
+
+If you find the gem too chatty even without this, you can quiet it down further:
+
+```ruby
+# config/initializers/rails_autoscale_agent.rb
+RailsAutoscaleAgent::Config.instance.quiet = true
+```
+
 ## 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.

data/lib/rails_autoscale_agent/config.rb

@@ -7,7 +7,7 @@ module RailsAutoscaleAgent
     include Singleton
 
     attr_accessor :report_interval, :logger, :api_base_url, :max_request_size,
-                  :dyno, :pid, :addon_name, :worker_adapters, :dev_mode
+                  :dyno, :pid, :addon_name, :worker_adapters, :dev_mode, :debug, :quiet
 
     def initialize
       require 'rails_autoscale_agent/worker_adapters/sidekiq'
@@ -25,11 +25,12 @@ module RailsAutoscaleAgent
       @addon_name = ENV['RAILS_AUTOSCALE_ADDON'] || 'RAILS_AUTOSCALE'
       @api_base_url = ENV["#{@addon_name}_URL"]
       @dev_mode = ENV['RAILS_AUTOSCALE_DEV'] == 'true'
+      @debug = dev_mode? || ENV['RAILS_AUTOSCALE_DEBUG'] == 'true'
       @pid = Process.pid
       @max_request_size = 100_000 # ignore request payloads over 100k since they skew the queue times
       @report_interval = 10 # this default will be overwritten during Reporter#register!
       @logger ||= defined?(Rails) ? Rails.logger : ::Logger.new(STDOUT)
-      @dyno = @dev_mode ? 'dev.1' : ENV['DYNO']
+      @dyno = dev_mode? ? 'dev.1' : ENV['DYNO']
     end
 
     def to_s
@@ -41,5 +42,7 @@ module RailsAutoscaleAgent
     end
 
     alias_method :dev_mode?, :dev_mode
+    alias_method :debug?, :debug
+    alias_method :quiet?, :quiet
   end
 end

data/lib/rails_autoscale_agent/logger.rb

@@ -13,26 +13,33 @@ module RailsAutoscaleAgent
   class LoggerProxy < Struct.new(:logger)
     TAG = '[RailsAutoscale]'
 
-    %w[info warn error].each do |name|
-      define_method name do |msg|
-        logger.send name, tag(msg)
-      end
+    def error(msg)
+      logger.error tag(msg)
+    end
+
+    def warn(msg)
+      logger.warn tag(msg)
+    end
+
+    def info(msg)
+      logger.info tag(msg) unless Config.instance.quiet?
     end
 
     def debug(msg)
       # Silence debug logs by default to avoiding being overly chatty (Rails logger defaults
-      # to DEBUG level in production).
-      # This uses a separate logger so that RAILS_AUTOSCALE_DEBUG
-      # shows debug logs regardless of Rails log level.
-      debug_logger.debug tag(msg) if ENV['RAILS_AUTOSCALE_DEBUG'] == 'true' || Config.instance.dev_mode?
+      # to DEBUG level in production). Setting RAILS_AUTOSCALE_DEBUG=true enables debug logs,
+      # even if the underlying logger severity level is INFO.
+      if Config.instance.debug?
+        if logger.respond_to?(:debug?) && logger.debug?
+          logger.debug tag(msg)
+        elsif logger.respond_to?(:info?) && logger.info?
+          logger.info tag("[DEBUG] #{msg}")
+        end
+      end
     end
 
     private
 
-    def debug_logger
-      @debug_loggers ||= ::Logger.new(STDOUT)
-    end
-
     def tag(msg)
       "#{TAG} #{msg}"
     end

data/lib/rails_autoscale_agent/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsAutoscaleAgent
-  VERSION = "0.9.0.beta.5"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_autoscale_agent
 version: !ruby/object:Gem::Version
-  version: 0.9.0.beta.5
+  version: 0.9.0
 platform: ruby
 authors:
 - Adam McCrea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-28 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -63,9 +63,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.4
 signing_key: