coverband 4.2.4.rc.2 → 4.2.4.rc.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b7fc3e6e0997909a0db557caf78e6ed4ddbf61441b80b44a35eebd195036fb3
-  data.tar.gz: 1adc60c3e2b7a805fd2c0f2863a1a7ec820593b0a918788fbf1ff18b7cfb9d52
+  metadata.gz: 13e53266c2fa52796b86da93197611c290f7a0c40e304ef5b75d24c45eed9db3
+  data.tar.gz: 95b685919c1edd7156f1f940d30f05381a1ac6684863557843001f8edf923125
 SHA512:
-  metadata.gz: 15db51c202c98481732a6092703fab2b83ef929dfbcd1fee0620f9275ec1be208e5f399b06ec29b2162ff2ca399dfa3db37b0e8e0e87c0abe2dd76eaa09fbaa7
-  data.tar.gz: b55cf6a2ef95973910ba21ec4bd6f6fd9172f70c0e77b10dcf62780ac37abbfeaec1d44611ebd9e4f2d1a3ef85a20b5b2869054c385bbd7cee5ce9bf775b1ce5
+  metadata.gz: 2e12f0556877efd6435887c447ef3278ab89c0c3ca6740b7ba0de33f9757e17038eb29a74297e9fb29707a8c4d9c999b1138117d3bb64607e0f4da82ca64e0c4
+  data.tar.gz: 27cfd67015140d2461fb2a9217d06c9782823433c8cbdad3be67e6cc05ea26125dab778656ff0b2023e5e806a277dd1c9028976ddd5dedcc8b90e3505d94598f

data/README.md

@@ -205,6 +205,7 @@ config.ignore +=  ['config/application.rb',
                    'config/environments/*',
                    'lib/tasks/*']
 ```
+
 ### View Tracking
 
 Coverband allows an optional feature to track all view files that are used by an application.
@@ -236,6 +237,14 @@ ENV['AWS_ACCESS_KEY_ID']
 ENV['AWS_SECRET_ACCESS_KEY']
 ```
 
+### Avoiding Cache Stampede
+
+If you have many servers and they all hit Redis at the same time you can see spikes in your Redis CPU, and memory. This is do to a concept called [cache stampede](https://en.wikipedia.org/wiki/Cache_stampede). It is better to spread out the reporting across your servers. A simple way to do this is to add a random wiggle on your background reporting. This configuration option allows a wiggle. The right amount of wiggle depends on the numbers of servers you have and how willing you are to have delays in your coverage reporting. I would recommend at least 1 second per server. 
+
+Add a wiggle (in seconds) to the background thread to avoid all your servers reporting at the same time:
+
+`config.reporting_wiggle = 30`
+
 ### Redis Hash Store
 
 Coverband on very high volume sites with many server processes reporting can have a race condition. To resolve the race condition and reduce Ruby memory overhead we have introduced a new Redis storage option. This moves the some of the work from the Ruby processes to Redis. It is worth noting because of this, it has a larger demands on the Redis server. So adjust your Redis instance accordingly. To help reduce the extra redis load you can also change the background reporting time period. 
@@ -342,6 +351,12 @@ If you are trying to debug locally wondering what code is being run during a req
 - Coverband 3.0.X+ requires Ruby 2.3+
 - Coverband currently requires Redis for production usage
 
+### Ruby and Rails Version Support
+
+We will match Heroku & Ruby's support lifetime, supporting the last 3 major Ruby releases. For details see [supported runtimes](https://devcenter.heroku.com/articles/ruby-support#supported-runtimes). 
+
+For Rails, we will follow the policy of the [Rails team maintenance policy](https://guides.rubyonrails.org/maintenance_policy.html). We officially support the last two major release versions, while providing minimal support (major bugs / security fixes) for an additional version. This means at the moment we primaryly target Rails 6.x, 5.x, and will try to keep current functionality working for Rails 4.x but may release new features that do not work on that target.
+
 # Contributing To Coverband
 
 If you are working on adding features, PRs, or bugfixes to Coverband this section should help get you going.

data/changes.md

@@ -86,6 +86,7 @@ Feature Ideas:
 - debug data now includes md5_hashes
 - added support to download coverage and view data in JSON format
 - documentation about working with environment variables
+- add cache wiggle to avoid Redis CPU spikes (cache stampede on Redis server)
 
 # Released
 

data/lib/coverband/configuration.rb

@@ -8,9 +8,11 @@ module Coverband
                   :background_reporting_enabled,
                   :background_reporting_sleep_seconds, :test_env,
                   :web_enable_clear, :gem_details, :web_debug, :report_on_exit,
-                  :simulate_oneshot_lines_coverage, :track_views, :view_tracker
+                  :simulate_oneshot_lines_coverage, :track_views, :view_tracker,
+                  :reporting_wiggle
 
-    attr_writer :logger, :s3_region, :s3_bucket, :s3_access_key_id, :s3_secret_access_key, :password
+    attr_writer :logger, :s3_region, :s3_bucket, :s3_access_key_id,
+                :s3_secret_access_key, :password
     attr_reader :track_gems, :ignore, :use_oneshot_lines_coverage
 
     #####
@@ -82,6 +84,7 @@ module Coverband
       @s3_secret_access_key = nil
       @redis_namespace = nil
       @redis_ttl = 2_592_000 # in seconds. Default is 30 days.
+      @reporting_wiggle = nil
     end
 
     def logger

data/lib/coverband/integrations/background.rb

@@ -33,6 +33,9 @@ module Coverband
           loop do
             Coverband.report_coverage
             Coverband.configuration.view_tracker&.report_views_tracked
+            if Coverband.configuration.reporting_wiggle
+              sleep_seconds = Coverband.configuration.background_reporting_sleep_seconds + rand(Coverband.configuration.reporting_wiggle.to_i)
+            end
             if Coverband.configuration.verbose
               logger.debug("Coverband: background reporting coverage (#{Coverband.configuration.store.type}). Sleeping #{sleep_seconds}s")
             end

data/lib/coverband/version.rb

@@ -5,5 +5,5 @@
 # use format '4.2.1.rc.1' ~> 4.2.1.rc to prerelease versions like v4.2.1.rc.2 and v4.2.1.rc.3
 ###
 module Coverband
-  VERSION = '4.2.4.rc.2'
+  VERSION = '4.2.4.rc.3'
 end

data/test/coverband/integrations/background_test.rb

@@ -19,6 +19,16 @@ class BackgroundTest < Minitest::Test
     2.times { Coverband::Background.start }
   end
 
+  def test_start_with_wiggle
+    Thread.expects(:new).yields.returns(ThreadDouble.new(true))
+    Coverband::Background.expects(:loop).yields
+    Coverband::Background.expects(:sleep).with(35)
+    Coverband::Background.expects(:rand).with(10).returns(5)
+    Coverband.configuration.reporting_wiggle = 10
+    Coverband::Collectors::Coverage.instance.expects(:report_coverage).once
+    2.times { Coverband::Background.start }
+  end
+
   def test_start_dead_thread
     Thread.expects(:new).yields.returns(ThreadDouble.new(false)).twice
     Coverband::Background.expects(:loop).yields.twice

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 4.2.4.rc.2
+  version: 4.2.4.rc.3
 platform: ruby
 authors:
 - Dan Mayer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-24 00:00:00.000000000 Z
+date: 2019-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3