puma-benchmark 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 64fb12eb3b6aa9f71b3a06822ee29952577a0d8e4a2c636584e376b605af8794
+  data.tar.gz: ac2497c7e142ae4f9857e2463f44d0fc5a57e761a3113099610f5e5ffdf3e873
+SHA512:
+  metadata.gz: d03337ca4b222bc92ea8a9b53e64e12fcf3acc52faf317bd2634473cbdb80d6d07fa3d80e5203f8443a71a2f8cdca0e42238c34f68816218bbad9835fb6f1c94
+  data.tar.gz: 469fa350cc4881ecb4a11e3d9fdfa574319a61b05340ad520b5d493b9c881c7da4e0985883ee00dc5731b267fb26b95507147913fc561ca210c7177c0a26753b

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.1

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 anil@joshsoftware.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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in puma-benchmark.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Anil Maurya
+
+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,54 @@
+# Puma::Benchmark
+
+This gem will help in setting right number of workers and threads for your application.
+
+## Installation
+
+This gem uses `wrk` for benchmarking, therefore you should first install `wrk` on your machine.
+For Mac: https://github.com/wg/wrk/wiki/Installing-wrk-on-Mac-OS-X
+For Linux: https://github.com/wg/wrk/wiki/Installing-wrk-on-Linux
+
+Install gem by command:
+
+    $ gem install puma-benchmark
+
+## Usage
+
+Usage: puma-benchmark [options]
+
+    -b, --base_url [BASE_URL]        Application base url for
+                       benchmarking, default: http://localhost:3000
+
+    -a, --api API                    API for benchmarking, example: /homes.json
+
+    -e, --environment                default: production
+
+    -t, --threads [Max Thread]       Max thread to be used per worker, default: 4
+
+    -w, --workers [Max Worker]       Max worker to be used for benchmarking, default: 4
+
+    -d, --duration [Duration]        Duration for each test (in seconds), default: 30
+
+    -h, --help                       Prints this help
+
+## Result
+
+![result](https://raw.githubusercontent.com/anilmaurya/puma-benchmark/master/puma-benchmark-result.png)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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/anilmaurya/puma-benchmark. 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::Benchmark project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/anilmaurya/puma-benchmark/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "puma/benchmark"
+
+# 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/exe/puma-benchmark

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'puma/benchmark'
+
+Puma::Benchmark.parse ARGV

data/lib/puma/benchmark.rb

@@ -0,0 +1,46 @@
+require "puma/benchmark/version"
+#require "puma/benchmark/config"
+require "puma/benchmark/core"
+require 'optparse'
+require 'optparse/uri'
+
+module Puma
+  module Benchmark
+    class Error < StandardError; end
+    
+    def self.run(params)
+      if params[:api]
+        Puma::Benchmark::Core.new(params).run
+      else
+        puts "API parameter is mandatory, try puma-benchmark -h"
+      end
+    end
+
+    def self.parse(options)
+      params = {}
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: puma-benchmark [options]"
+
+        opts.on("-b", "--base_url [BASE_URL]", URI,  "Application base url for
+                       benchmarking, default: http://localhost:3000")
+
+        opts.on("-a", "--api API", "API for benchmarking, example: /homes.json")
+
+        opts.on("-e", "--environment", "default: production")
+        
+        opts.on("-t", "--threads [Max Thread]", "Max thread to be used per worker, default: 4")
+
+        opts.on("-w", "--workers [Max Worker]", "Max worker to be used for benchmarking, default: 4")
+
+        opts.on("-d", "--duration [Duration]", "Duration for each test (in seconds), default: 30")
+
+        opts.on("-h", "--help", "Prints this help") do
+          puts opts
+          exit
+        end
+      end.parse!(into: params)
+
+      run(params)
+    end
+  end
+end

data/lib/puma/benchmark/core.rb

@@ -0,0 +1,66 @@
+require 'open3'
+require 'pp'
+require 'puma/benchmark/print_result'
+
+module Puma
+  module Benchmark
+    class Core
+      def initialize(params)
+        @base_url    = params[:base_url] || 'http://localhost:3000'
+        @api         = params[:api]
+        @max_threads = params[:threads].to_i || 4
+        @max_workers = params[:workers].to_i || 4
+        @duration    = params[:duration] || 30
+        @environment = params[:environment] || 'production'
+        @result      = []
+      end
+
+      def current_dir
+        File.expand_path(File.dirname('.'))
+      end
+
+      def pid_file
+        "#{current_dir}/tmp/pids/server.pid"
+      end
+
+      def run
+        @max_workers.times do |worker_count|
+          @max_threads.times do |thread_count|
+            process(worker_count + 1, thread_count + 1)
+          end
+        end
+        Puma::Benchmark::PrintResult.new.call(@result)
+      end
+
+      def process(worker_count, thread_count)
+        if !File.exist?(pid_file)
+          fork {
+            system("RAILS_ENV=#{@environment} puma -w #{worker_count} -t #{thread_count}")
+          }
+          sleep(5)
+        end
+
+        print_timer
+        stdout, stderr, status = Open3.capture3("wrk -t 2 -c 100 -d #{@duration}s  #{@base_url}/#{@api}")
+        pp stdout
+
+        #p "Requests / sec: #{stdout.split(' ')[-3]}"
+        req_per_sec = stdout.split(' ')[-3]
+        @result << {workers: worker_count.to_s, threads: thread_count.to_s, req_per_sec: req_per_sec}
+        system("kill #{File.read(pid_file)}")
+        sleep(5)
+      end
+
+      def print_timer
+        fork{
+          p 'Sending request for 30 secs'
+          30.times do |n|
+            print "    #{30 - n} sec left \r"
+            $stdout.flush
+            sleep(1)
+          end
+        }
+      end
+    end
+  end
+end

data/lib/puma/benchmark/print_result.rb

@@ -0,0 +1,33 @@
+module Puma
+  module Benchmark
+    class PrintResult
+      def call(result)
+        set_columns
+        write_divider
+        write_header
+        write_divider
+        result.each { |h| write_line(h) }
+        write_divider
+      end
+
+      def set_columns
+        @columns = {workers: {:label=>"No. of workers",    :width=>15},
+                    threads: {:label=>"No. of threads",    :width=>15},
+                    req_per_sec: {:label=>"No. of requests/sec",    :width=>20}}
+      end
+
+      def write_header
+        puts "| #{ @columns.map { |_,g| g[:label].ljust(g[:width]) }.join(' | ') } |"
+      end
+
+      def write_divider
+        puts "+-#{ @columns.map { |_,g| "-"*g[:width] }.join("-+-") }-+"
+      end
+
+      def write_line(h)
+        str = h.keys.map { |k| h[k].ljust(@columns[k][:width]) }.join(" | ")
+        puts "| #{str} |"
+      end
+    end
+  end
+end

data/lib/puma/benchmark/version.rb

@@ -0,0 +1,5 @@
+module Puma
+  module Benchmark
+    VERSION = "0.1.0"
+  end
+end

data/puma-benchmark.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "puma/benchmark/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "puma-benchmark"
+  spec.version       = Puma::Benchmark::VERSION
+  spec.authors       = ["Anil Maurya"]
+  spec.email         = ["anilmaurya8dec@gmail.com"]
+
+  spec.summary       = %q{Benchmark puma requests per sec for different workers and thread count}
+  spec.description   = %q{Benchmark puma requests per sec for different workers and thread count}
+  spec.homepage      = "https://github.com/anilmaurya/puma-benchmark"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # 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('..', __FILE__)) 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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: puma-benchmark
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anil Maurya
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-07-11 00:00:00.000000000 Z
+dependencies:
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Benchmark puma requests per sec for different workers and thread count
+email:
+- anilmaurya8dec@gmail.com
+executables:
+- puma-benchmark
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/puma-benchmark
+- lib/puma/benchmark.rb
+- lib/puma/benchmark/core.rb
+- lib/puma/benchmark/print_result.rb
+- lib/puma/benchmark/version.rb
+- puma-benchmark-result.png
+- puma-benchmark.gemspec
+homepage: https://github.com/anilmaurya/puma-benchmark
+licenses:
+- MIT
+metadata: {}
+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.0.3
+signing_key:
+specification_version: 4
+summary: Benchmark puma requests per sec for different workers and thread count
+test_files: []