puma-pool-usage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 622845ccb16eb65e8b3822c0386090724f0b524c1b50c228c0a2364d93ab6a70
+  data.tar.gz: 1239bcc7a2c45cb46982d6c01cc5278fc4347a727b597a1f6c812985e0d63f87
+SHA512:
+  metadata.gz: 6b803c243773fc8e6cb6b641c04b4a5b42a1114ec1d327ff04d811a66a267dba18c7e5701a0067943e02d8251b369a9d1be55b1b498b5387699db8b54058589f
+  data.tar.gz: 8a2d152f58bfbffae52fa9f9870cffeb99787df054c5324c9709348e865ade615f1b20c02ce8e5c4284239669934ddfbc1fe1a3cfd88aafb59ac1664244dd9d8

data/.gitignore

@@ -0,0 +1,15 @@
+.DS_Store
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+Gemfile.lock
+gemfiles/*.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  NewCops: enable
+
+Bundler/OrderedGems:
+  Exclude:
+    - "gemfiles/**/*"
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+    - "*.gemspec"
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - "gemfiles/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,29 @@
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+before_install: gem install bundler -v 2.0.2
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=91fd1b5f4e32e12f68c365516db8abff11ac17b75d043c7b18e672b836a92f15
+
+gemfile:
+  - gemfiles/rails_5.gemfile
+  - gemfiles/rails_6.gemfile
+  - gemfiles/latest.gemfile
+
+language: ruby
+
+rvm:
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
+
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/Appraisals

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+appraise "rails-5" do
+  gem "rails", "~> 5.0"
+  gem "puma", "3.12.0"
+end
+
+appraise "rails-6" do
+  gem "rails", "~> 6.0"
+  gem "puma", "~> 4.0"
+end
+
+appraise "latest" do
+  gem "rails"
+  gem "puma"
+end

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Puma Pool Usage
+
+The changelog for Puma Pool Usage is maintained in the [GitHub Releases](https://github.com/simplymadeapps/puma-pool-usage/releases).

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at contact@simplymadeapps.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Simply Made Apps
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# Puma Pool Usage
+
+[![Build Status](https://travis-ci.org/simplymadeapps/puma-pool-usage.svg?branch=master)](https://travis-ci.org/simplymadeapps/puma-pool-usage)
+[![Code Climate](https://codeclimate.com/github/simplymadeapps/puma-pool-usage/badges/gpa.svg)](https://codeclimate.com/github/simplymadeapps/puma-pool-usage)
+[![Test Coverage](https://codeclimate.com/github/simplymadeapps/puma-pool-usage/badges/coverage.svg)](https://codeclimate.com/github/simplymadeapps/puma-pool-usage/coverage)
+
+A Puma plugin that interprets usage statistics for the percentage of your resources under load. Uses Rails to log this statistic. Inspired by [Tomas Ruzicka](https://github.com/LeZuse) and Heroku's pool usage statistics.
+
+Look at this neat log:
+
+    source=PUMA pid=74840 sample#pool_usage=0.8
+
+If your web server is fielding no requests, usage will be 0.0 (0%). If every single resource has a request, usage will be 1.0 (100%). If you have a backlog of requests that cannot be processed because no resources are available, usage can be over 100% (like 1.4).
+
+Wish to chart this data, setup alerts, or scale your servers based on it? Great idea, but it's beyond the scope of this plugin. This plugin provides the data, what you do with the data is up to you.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "puma-pool-usage"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install puma-pool-usage
+
+## Usage
+
+In your Puma configuration file (config/puma.rb), add the following line:
+
+```ruby
+plugin :pool_usage
+```
+
+Restart your server and you're all set. 
+
+## Configuration
+
+By default, Puma Pool Usage will log every Puma worker every 60 seconds. You can configure this via the environment variable `PUMA_STATS_FREQUENCY`. To gather this data only every 5 minutes, set your environment like so:
+
+    PUMA_STATS_FREQUENCY=300
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/simplymadeapps/puma-pool-usage. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Puma::Pool::Usage project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/simplymadeapps/puma-pool-usage/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/latest.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails"
+gem "puma"
+
+gemspec path: "../"

data/gemfiles/rails_5.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.0"
+gem "puma", "3.12.0"
+
+gemspec path: "../"

data/gemfiles/rails_6.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.0"
+gem "puma", "~> 4.0"
+
+gemspec path: "../"

data/lib/puma/plugin/pool_usage.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "json"
+require "puma/plugin"
+require "rails"
+
+# Plugin that outputs pool usage into Rails logs.
+# Usage expressed via a percentage of your available resources as a float.
+#
+# @example when running in cluster mode (pid is logged)
+#   source=PUMA pid=123456 sample#pool_usage=0.8
+#
+# @example when not running in cluster mode (pid is logged as 0)
+#   source=PUMA pid=0 sample#pool_usage=0.5
+Puma::Plugin.create do
+  # Method called by Puma on startup.
+  #
+  # @param [Puma::Launcher] _launcher Puma launcher object, ignored.
+  def start(_launcher)
+    in_background do
+      loop do
+        sleep ENV.fetch("PUMA_STATS_FREQUENCY", 60).to_i
+        find_and_log_pool_usage
+        Rails.logger.flush
+      end
+    end
+  end
+
+  private
+
+  # Find the Puma stats necessary depending on mode (single vs. cluster).
+  # Sends statistics for logging.
+  def find_and_log_pool_usage
+    stats = JSON.parse(Puma.stats, symbolize_names: true)
+
+    if stats[:worker_status]
+      stats[:worker_status].each { |worker| log_pool_usage(worker[:last_status], pid: worker[:pid]) }
+    else
+      log_pool_usage(stats, pid: 0)
+    end
+  end
+
+  # Calculate and log, assuing Puma has started and provided stats.
+  #
+  # @param [Hash] status Puma statistics.
+  # @param [Integer] pid Process identifier for this particular Puma worker.
+  def log_pool_usage(status, pid:)
+    return if status[:pool_capacity].nil?
+
+    pool_usage = (status[:running] - (status[:pool_capacity] - status[:backlog])) / status[:running].to_f
+    Rails.logger.info "source=PUMA pid=#{pid} sample#pool_usage=#{pool_usage}"
+  end
+end

data/puma-pool-usage.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = "puma-pool-usage"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Brandon Medenwald"]
+  spec.email         = ["brandon@simplymadeapps.com"]
+
+  spec.summary       = "Puma pool usage statistics in your logs"
+  spec.description   = "Add pool usage statistics within your log files."
+  spec.homepage      = "https://www.github.com/simplymadeapps/puma-pool-usage"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://www.github.com/simplymadeapps/puma-pool-usage/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{^(spec)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "puma", ">= 3.12", "< 5.0"
+  spec.add_runtime_dependency "rails", ">= 5.0"
+
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.83.0"
+  spec.add_development_dependency "simplecov", "< 0.18" # https://github.com/codeclimate/test-reporter/issues/413
+  spec.add_development_dependency "simplecov-rcov"
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: puma-pool-usage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brandon Medenwald
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.12'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.12'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.83.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.83.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  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: Add pool usage statistics within your log files.
+email:
+- brandon@simplymadeapps.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Appraisals
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/.bundle/config
+- gemfiles/latest.gemfile
+- gemfiles/rails_5.gemfile
+- gemfiles/rails_6.gemfile
+- lib/puma/plugin/pool_usage.rb
+- puma-pool-usage.gemspec
+homepage: https://www.github.com/simplymadeapps/puma-pool-usage
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/simplymadeapps/puma-pool-usage
+  source_code_uri: https://www.github.com/simplymadeapps/puma-pool-usage
+  changelog_uri: https://www.github.com/simplymadeapps/puma-pool-usage/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.3
+signing_key: 
+specification_version: 4
+summary: Puma pool usage statistics in your logs
+test_files: []