barnes 0.0.4 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19c9b546f067ae2704fa77ae6d9427ec127066297e5b764946eee6182ecbee10
-  data.tar.gz: '01368678dd52fde279caaa874e961fbd804083818d77f0d35ceb1c0a7fe3a676'
+  metadata.gz: 5afa9a13612433356ad5a2df69f6fa8e418bb2f202720f15da65145d0c7d40dc
+  data.tar.gz: 6b67b8ec0db255dacde33e74f1c36510db0a8859c67b8a465df6f5b6da26a803
 SHA512:
-  metadata.gz: ca830409f6dc45d30e14bb69c1593724ed9a563eaf2082588225f46fffe189c0a1363d445cc499b7b96cf648a1ffaf80267a668ec5a4b15fef2af915bd7765b8
-  data.tar.gz: e73a76762d62b85007edce9bd6fdc7a21ffff41115dcf284587f74787b740de303c44592be65ff720cbda9310ac7dfec43db7f6d349dc4fc085eef3daca0a8c0
+  metadata.gz: 17e28cbca9e2a77a773d94ce06ccf46e2e2ca948482b408ac9f2a6fa13fa9401a186bb1067174d774b707c15a562f5b6c70b48163e41f5cb3152b36e1c190a5f
+  data.tar.gz: cde051f96eaf3b2dc8ef5eb1bfa943ef0b1dd694c40857f6cbe48cff4eb8274ed4749f1616582df27466b967d4b98be5987fc5673bda4f3d9f8adbbcba7250c8

data/.github/workflows/check_changelog.yml

@@ -0,0 +1,12 @@
+name: Check Changelog
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Check that CHANGELOG is touched
+      run: |
+        cat $GITHUB_EVENT_PATH | jq .pull_request.title |  grep -i '\[\(\(changelog skip\)\|\(ci skip\)\)\]' ||  git diff remotes/origin/${{ github.base_ref }} --name-only | grep CHANGELOG.md

data/.travis.yml

@@ -2,4 +2,4 @@ sudo: false
 language: ruby
 rvm:
   - 2.5.0
-before_install: gem install bundler -v 1.15.4
+before_install: gem install bundler -v 2.1.0

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## Master (unrleased)
+
+## 0.0.8
+
+- Fix warnings in Ruby 2.7
+
+## 0.0.7
+
+- Report when an app is using Puma
+
+## 0.0.6
+
+- Support Puma max threads, support Puma spawned threads
+- Drop Puma backlog metric
+
+## 0.0.5
+
+- Support Puma pool capacity value #15
+
 ## 0.0.4
 
 - Support Puma backlog #14

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'simplecov', :require => false, :group => :test
+gem 'simplecov', :require => false, :group => :test
+gem 'm'

data/README.md

@@ -4,9 +4,9 @@ A fork of [trashed](https://github.com/basecamp/trashed) focused on Ruby metrics
 
 ## Setup
 
-### Rails 5
+### Rails 3, 4, 5, and 6
 
-On Rails 5 (and Rails 3 and 4), add this to your Gemfile:
+On Rails 6 (and Rails 3 and 4 and 5), add this to your Gemfile:
 
 ```
 gem "barnes"
@@ -32,7 +32,7 @@ Then run:
 $ bundle install
 ```
 
-In your application:
+In your puma.rb file:
 
 
 ```ruby
@@ -42,6 +42,9 @@ require 'barnes'
 Then you'll need to start the client with default values:
 
 ```ruby
-Barnes.start
+before_fork do
+  # worker configuration
+  Barnes.start
+end
 ```
 

data/Rakefile

@@ -29,7 +29,8 @@ task :default => :test
 
 desc 'Run tests'
 Rake::TestTask.new :test do |t|
-  t.libs << 'test/lib'
-  t.pattern = 'test/*_test.rb'
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end

data/barnes.gemspec

@@ -21,12 +21,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'statsd-ruby', '~> 1.1'
   spec.required_ruby_version = '>= 2.2.0'
 
+  spec.add_runtime_dependency 'statsd-ruby', '~> 1.1'
   spec.add_runtime_dependency 'multi_json', '~> 1'
 
-  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'rack',     '~> 2'
+  spec.add_development_dependency 'rake',     '>= 10'
   spec.add_development_dependency 'minitest', '~> 5.3'
-  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "puma",     '~> 3.12'
+  spec.add_development_dependency "wait_for_it",     '~> 0.1'
 end

data/lib/barnes.rb

@@ -54,7 +54,12 @@ module Barnes
         panels << Barnes::ResourceUsage.new(sample_rate)
       end
 
-      Periodic.new reporter: reporter, sample_rate: sample_rate, panels: panels
+      Periodic.new(
+        reporter:    reporter,
+        sample_rate: sample_rate,
+        panels:      panels,
+        debug:       ENV['BARNES_DEBUG']
+      )
     end
   end
 end

data/lib/barnes/instruments/puma_instrument.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'barnes/instruments/puma_stats_value'
+module Barnes
+  module Instruments
+    class PumaInstrument
+      def initialize(sample_rate=nil)
+        @debug = ENV["BARNES_DEBUG_PUMA_STATS"]
+        @puma_has_stats = (defined?(::Puma) && ::Puma.respond_to?(:stats))
+      end
+
+      def valid?
+        return false unless defined?(Puma)
+        return false unless ENV["DYNO"] && ENV["DYNO"].start_with?("web")
+        true
+      end
+
+      def start!(state)
+        require 'multi_json'
+      end
+
+      def json_stats
+        return {} unless @puma_has_stats
+        MultiJson.load(::Puma.stats || "{}")
+
+      # Puma loader has not been initialized yet
+      rescue NoMethodError => e
+        raise e unless e.message =~ /nil/
+        raise e unless e.message =~ /stats/
+        return {}
+      end
+
+      def instrument!(state, counters, gauges)
+        gauges['using.puma'] = 1
+
+        stats = json_stats
+        return if stats.empty?
+
+        puts "Puma debug stats from barnes: #{stats}" if @debug
+
+        pool_capacity = StatValue.new(stats, "pool_capacity").value
+        max_threads   = StatValue.new(stats, "max_threads").value
+        spawned       = StatValue.new(stats, "running").value
+
+        gauges[:'pool.capacity']    = pool_capacity if pool_capacity
+        gauges[:'threads.max']      = max_threads   if max_threads
+        gauges[:'threads.spawned']  = spawned       if spawned
+      end
+    end
+  end
+end

data/lib/barnes/instruments/puma_stats_value.rb

@@ -0,0 +1,49 @@
+module Barnes
+  module Instruments
+    class PumaInstrument
+      # This class is responsible for consuming a puma
+      # generated stats hash that can come in two "flavors"
+      # one is a "single process" server which will look like this:
+      #
+      #    { "backlog": 0, "running": 0, "pool_capacity": 16 }
+      #
+      # The other is a multiple cluster server that will look like this:
+      #
+      #    {"workers"=>2, "phase"=>0, "booted_workers"=>2, "old_workers"=>0, "worker_status"=>[{"pid"=>35020, "index"=>0, "phase"=>0, "booted"=>true, "last_checkin"=>"2018-05-21T19:53:18Z", "last_status"=>{"backlog"=>0, "running"=>5, "pool_capacity"=>5}}, {"pid"=>35021, "index"=>1, "phase"=>0, "booted"=>true, "last_checkin"=>"2018-05-21T19:53:18Z", "last_status"=>{"backlog"=>0, "running"=>5, "pool_capacity"=>5}}]}
+      #
+      class StatValue
+        attr_reader :stats, :key
+
+        def initialize(stats, key)
+          @stats   = stats
+          @key     = key
+          @cluster = stats.key?("worker_status")
+        end
+
+        def single?
+          !cluster?
+        end
+
+        def cluster?
+          @cluster
+        end
+
+        # For single worker process use value directly
+        # for multiple workers use the sum.
+        #
+        # https://github.com/puma/puma/pull/1532
+        def value
+          return stats[key] if single?
+          first_worker = stats["worker_status"].first
+          return nil unless first_worker && first_worker["last_status"].key?(key)
+
+          value = 0
+          stats["worker_status"].each do |worker_status|
+            value += worker_status["last_status"][key] || 0
+          end
+          return value
+        end
+      end
+    end
+  end
+end

data/lib/barnes/periodic.rb

@@ -28,10 +28,10 @@ module Barnes
   # to a reporting instance of `Barnes::Reporter` at a semi-regular
   # rate.
   class Periodic
-    def initialize(reporter:, sample_rate: 1, panels: [])
+    def initialize(reporter:, sample_rate: 1, debug: false, panels: [])
       @reporter = reporter
       @reporter.sample_rate = sample_rate
-
+      @debug = debug
       # compute interval based on a 60s reporting phase.
       @interval = sample_rate * 60.0
       @panels = panels
@@ -57,6 +57,8 @@ module Barnes
             @panels.each do |panel|
               panel.instrument! env[STATE], env[COUNTERS], env[GAUGES]
             end
+
+            puts env.to_json if @debug
             @reporter.report env
           end
         end

data/lib/barnes/railtie.rb

@@ -41,7 +41,7 @@ module Barnes
     }
 
     initializer 'barnes' do |app|
-      Barnes.start(config.barnes)
+      Barnes.start(**config.barnes)
     end
   end
 end

data/lib/barnes/resource_usage.rb

@@ -28,11 +28,11 @@ module Barnes
     def initialize(sample_rate)
       super()
 
-      require 'barnes/instruments/puma_backlog'
-      backlog_reporter = Barnes::Instruments::PumaBacklog.new
+      require 'barnes/instruments/puma_instrument'
+      puma_instrument = Barnes::Instruments::PumaInstrument.new
 
-      if backlog_reporter.valid?
-        instrument backlog_reporter
+      if puma_instrument.valid?
+        instrument puma_instrument
       end
 
       require 'barnes/instruments/stopwatch'

data/lib/barnes/version.rb

@@ -22,5 +22,5 @@
 #
 
 module Barnes
-  VERSION = "0.0.4"
+  VERSION = "0.0.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barnes
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.8
 platform: ruby
 authors:
 - schneems
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-12 00:00:00.000000000 Z
+date: 2020-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statsd-ruby
@@ -39,17 +39,31 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10'
 - !ruby/object:Gem::Dependency
@@ -67,19 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.3'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: wait_for_it
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0.1'
 description: Report GC usage data to StatsD.
 email:
 - richard.schneeman@gmail.com
@@ -88,12 +116,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yaml"
+- ".github/workflows/check_changelog.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -105,7 +133,8 @@ files:
 - lib/barnes/consts.rb
 - lib/barnes/instruments/gctools_oobgc.rb
 - lib/barnes/instruments/object_space_counter.rb
-- lib/barnes/instruments/puma_backlog.rb
+- lib/barnes/instruments/puma_instrument.rb
+- lib/barnes/instruments/puma_stats_value.rb
 - lib/barnes/instruments/ree_gc.rb
 - lib/barnes/instruments/ruby_gc.rb
 - lib/barnes/instruments/stopwatch.rb
@@ -134,8 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby GC stats => StatsD

data/lib/barnes/instruments/puma_backlog.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module Barnes
-  module Instruments
-    class PumaBacklog
-      def initialize(sample_rate=nil)
-      end
-
-      def valid?
-        defined?(Puma) &&
-          Puma.respond_to?(:stats) &&
-          ENV["DYNO"] && ENV["DYNO"].start_with?("web")
-      end
-
-      def start!(state)
-        require 'multi_json'
-      end
-
-      def json_stats
-        MultiJson.load(Puma.stats || "{}")
-
-      # Puma loader has not been initialized yet
-      rescue NoMethodError => e
-        raise e unless e.message =~ /nil/
-        raise e unless e.message =~ /stats/
-        return {}
-      end
-
-      # For single worker process use backlog directly
-      # for multiple workers sum backlog.
-      #
-      # https://github.com/puma/puma/pull/1532
-      def instrument!(state, counters, gauges)
-        stats = self.json_stats
-        return if stats.empty?
-
-        backlog = stats["backlog"]
-        if backlog.nil?
-          backlog = stats["worker_status"].map do |worker_status|
-            worker_status["last_status"]["backlog"]
-          end.reduce(0, :+)
-        end
-
-        gauges[:'backlog.requests'] = backlog
-      end
-    end
-  end
-end