puma_log_stats 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d2365c2fea363f5a57d104816af39c026229ed86df3216935e1199b735aa7e9
+  data.tar.gz: 7fbaf83a73e93c3bd0eeb57929b994ec3d44138bd1b4eed0caabece2a75aa808
+SHA512:
+  metadata.gz: 18ef30e7de888693c2a1d3df4c0ed1628f812205ce6cdb0eb7813c07275fd22eb9debaf94349d0faff169b0407e854cdb716fede6b8c69e3020484c4874aa837
+  data.tar.gz: b8f248a1b327958fffb319b6403e7355e213d221d102a5791bf2f39168399156f64ed520757a4483651275494aa6c42312b75eb9a10a62eb85e95ef0695a130e

data/.gitignore

@@ -0,0 +1,3 @@
+.ruby-version
+Gemfile.lock
+pkg/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in puma_log_stats.gemspec
+gemspec

data/README.md

@@ -0,0 +1,41 @@
+# PumaLogStats
+
+Puma plugin to log server stats whenever the number of concurrent requests exceeds a configured threshold.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'puma_log_stats'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install puma_log_stats
+
+## Usage
+
+This plugin is loaded using Puma's plugin API. To enable, add a `plugin :log_stats` directive to your Puma config DSL, then configure the `LogStats` object with any additional configuration:
+
+```ruby
+# config/puma.rb
+
+plugin :log_stats
+LogStats.threshold = 2
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/wjordan/puma_log_stats.

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test)

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'puma_log_stats'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/puma/plugin/log_stats.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'puma'
+require 'puma/plugin'
+require 'json'
+
+# Puma plugin to log server stats whenever the number of
+# concurrent requests exceeds a configured threshold.
+module LogStats
+  class << self
+    # Minimum concurrent requests per process that will trigger logging server
+    # stats, or nil to disable logging.
+    # Default is the max number of threads in the server's thread pool.
+    # If this attribute is a Proc, it will be re-evaluated each interval.
+    attr_accessor :threshold
+    LogStats.threshold = :max
+
+    # Interval between logging attempts in seconds.
+    attr_accessor :interval
+    LogStats.interval = 1
+
+    # Proc to filter backtraces.
+    attr_accessor :backtrace_filter
+    LogStats.backtrace_filter = ->(bt) { bt }
+  end
+
+  Puma::Plugin.create do
+    attr_reader :launcher
+
+    def start(launcher)
+      @launcher = launcher
+      launcher.events.register(:state) do |state|
+        @state = state
+        stats_logger_thread if state == :running
+      end
+    end
+
+    private
+
+    def stats_logger_thread
+      Thread.new do
+        if Thread.current.respond_to?(:name=)
+          Thread.current.name = 'puma stats logger'
+        end
+        stats_logger_loop while @state == :running
+      end
+    end
+
+    def stats_logger_loop
+      sleep LogStats.interval
+      return unless server
+
+      if should_log?
+        stats = server_stats
+        stats[:threads] = thread_backtraces
+        stats[:gc] = GC.stat
+        log stats.to_json
+      end
+    rescue StandardError => e
+      log "LogStats failed: #{e}\n  #{e.backtrace.join("\n    ")}"
+    end
+
+    def log(str)
+      launcher.events.log str
+    end
+
+    # Save reference to Server object from the thread-local key.
+    def server
+      @server ||= Thread.list.map { |t| t[Puma::Server::ThreadLocalKey] }.compact.first
+    end
+
+    STAT_METHODS = %i[backlog running pool_capacity max_threads requests_count].freeze
+    def server_stats
+      STAT_METHODS.select(&server.method(:respond_to?))
+                  .map { |name| [name, server.send(name) || 0] }.to_h
+    end
+
+    # True if current server load meets configured threshold.
+    def should_log?
+      threshold = LogStats.threshold
+      threshold = threshold.call if threshold.is_a?(Proc)
+      threshold = server.max_threads if threshold == :max
+      threshold && (server.max_threads - server.pool_capacity) >= threshold
+    end
+
+    def thread_backtraces
+      worker_threads.map do |t|
+        name = t.respond_to?(:name) ? t.name : thread.object_id.to_s(36)
+        [name, LogStats.backtrace_filter.call(t.backtrace)]
+      end.sort.to_h
+    end
+
+    # List all non-idle worker threads in the thread pool.
+    def worker_threads
+      server.instance_variable_get(:@thread_pool)
+            .instance_variable_get(:@workers)
+            .reject { |t| t.backtrace.first.match?(/thread_pool\.rb.*sleep/) }
+    end
+  end
+end

data/lib/puma_log_stats/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PumaLogStats
+  VERSION = '0.1.0'
+end

data/lib/puma_log_stats.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'puma_log_stats/version'

data/puma_log_stats.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/puma_log_stats/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'puma_log_stats'
+  spec.version       = PumaLogStats::VERSION
+  spec.authors       = ['Will Jordan']
+  spec.email         = ['will@code.org']
+
+  spec.summary       = 'Logs Puma stats when concurrent requests are high.'
+  spec.description   = 'Puma plugin to log server stats whenever the number ' \
+                       'of concurrent requests exceeds a configured threshold.'
+  spec.homepage      = 'https://github.com/wjordan/puma_log_stats'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/wjordan/puma_log_stats'
+  spec.metadata['changelog_uri'] = 'https://github.com/wjordan/puma_log_stats/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'puma', '>= 2.7', '< 6'
+
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: puma_log_stats
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Will Jordan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: rake
+  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: Puma plugin to log server stats whenever the number of concurrent requests
+  exceeds a configured threshold.
+email:
+- will@code.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/puma/plugin/log_stats.rb
+- lib/puma_log_stats.rb
+- lib/puma_log_stats/version.rb
+- puma_log_stats.gemspec
+homepage: https://github.com/wjordan/puma_log_stats
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/wjordan/puma_log_stats
+  source_code_uri: https://github.com/wjordan/puma_log_stats
+  changelog_uri: https://github.com/wjordan/puma_log_stats/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Logs Puma stats when concurrent requests are high.
+test_files: []