├── lib └── puma │ ├── benchmark │ ├── version.rb │ ├── print_result.rb │ └── core.rb │ └── benchmark.rb ├── puma-benchmark-result.png ├── .gitignore ├── Gemfile ├── .travis.yml ├── test ├── test_helper.rb └── puma │ └── benchmark_test.rb ├── bin ├── setup └── console ├── exe └── puma-benchmark ├── Rakefile ├── LICENSE.txt ├── puma-benchmark.gemspec ├── README.md └── CODE_OF_CONDUCT.md /lib/puma/benchmark/version.rb: -------------------------------------------------------------------------------- 1 | module Puma 2 | module Benchmark 3 | VERSION = "0.1.1" 4 | end 5 | end 6 | -------------------------------------------------------------------------------- /puma-benchmark-result.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/anilmaurya/puma-benchmark/HEAD/puma-benchmark-result.png -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /.bundle/ 2 | /.yardoc 3 | /_yardoc/ 4 | /coverage/ 5 | /doc/ 6 | /pkg/ 7 | /spec/reports/ 8 | /tmp/ 9 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source "https://rubygems.org" 2 | 3 | # Specify your gem's dependencies in puma-benchmark.gemspec 4 | gemspec 5 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | --- 2 | sudo: false 3 | language: ruby 4 | cache: bundler 5 | rvm: 6 | - 2.6.5 7 | before_install: gem install bundler -v 2.0.1 8 | -------------------------------------------------------------------------------- /test/test_helper.rb: -------------------------------------------------------------------------------- 1 | $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__) 2 | require "puma/benchmark" 3 | 4 | require "minitest/autorun" 5 | -------------------------------------------------------------------------------- /bin/setup: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -euo pipefail 3 | IFS=$'\n\t' 4 | set -vx 5 | 6 | bundle install 7 | 8 | # Do any other automated setup that you need to do here 9 | -------------------------------------------------------------------------------- /exe/puma-benchmark: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | lib = File.expand_path('../lib', __FILE__) 3 | $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) 4 | require 'puma/benchmark' 5 | 6 | Puma::Benchmark.parse ARGV -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | require "bundler/gem_tasks" 2 | require "rake/testtask" 3 | 4 | Rake::TestTask.new(:test) do |t| 5 | t.libs << "test" 6 | t.libs << "lib" 7 | t.test_files = FileList["test/**/*_test.rb"] 8 | end 9 | 10 | task :default => :test 11 | -------------------------------------------------------------------------------- /test/puma/benchmark_test.rb: -------------------------------------------------------------------------------- 1 | require "test_helper" 2 | 3 | class Puma::BenchmarkTest < Minitest::Test 4 | def test_that_it_has_a_version_number 5 | refute_nil ::Puma::Benchmark::VERSION 6 | end 7 | 8 | def test_it_does_something_useful 9 | assert false 10 | end 11 | end 12 | -------------------------------------------------------------------------------- /bin/console: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | require "bundler/setup" 4 | require "puma/benchmark" 5 | 6 | # You can add fixtures and/or initialization code here to make experimenting 7 | # with your gem easier. You can also use a different console, if you like. 8 | 9 | # (If you use this, don't forget to add pry to your Gemfile!) 10 | # require "pry" 11 | # Pry.start 12 | 13 | require "irb" 14 | IRB.start(__FILE__) 15 | -------------------------------------------------------------------------------- /lib/puma/benchmark/print_result.rb: -------------------------------------------------------------------------------- 1 | module Puma 2 | module Benchmark 3 | class PrintResult 4 | def call(result) 5 | set_columns 6 | write_divider 7 | write_header 8 | write_divider 9 | result.each { |h| write_line(h) } 10 | write_divider 11 | end 12 | 13 | def set_columns 14 | @columns = {workers: {:label=>"No. of workers", :width=>15}, 15 | threads: {:label=>"No. of threads", :width=>15}, 16 | req_per_sec: {:label=>"No. of requests/sec", :width=>20}} 17 | end 18 | 19 | def write_header 20 | puts "| #{ @columns.map { |_,g| g[:label].ljust(g[:width]) }.join(' | ') } |" 21 | end 22 | 23 | def write_divider 24 | puts "+-#{ @columns.map { |_,g| "-"*g[:width] }.join("-+-") }-+" 25 | end 26 | 27 | def write_line(h) 28 | str = h.keys.map { |k| h[k].ljust(@columns[k][:width]) }.join(" | ") 29 | puts "| #{str} |" 30 | end 31 | end 32 | end 33 | end -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2020 Anil Maurya 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in 13 | all copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | THE SOFTWARE. 22 | -------------------------------------------------------------------------------- /lib/puma/benchmark.rb: -------------------------------------------------------------------------------- 1 | require "puma/benchmark/version" 2 | #require "puma/benchmark/config" 3 | require "puma/benchmark/core" 4 | require 'optparse' 5 | require 'optparse/uri' 6 | 7 | module Puma 8 | module Benchmark 9 | class Error < StandardError; end 10 | 11 | def self.run(params) 12 | if params[:api] 13 | Puma::Benchmark::Core.new(params).run 14 | else 15 | puts "API parameter is mandatory, try puma-benchmark -h" 16 | end 17 | end 18 | 19 | def self.parse(options) 20 | params = {} 21 | opt_parser = OptionParser.new do |opts| 22 | opts.banner = "Usage: puma-benchmark [options]" 23 | 24 | opts.on("-b", "--base_url [BASE_URL]", URI, "Application base url for 25 | benchmarking, default: http://localhost:3000") 26 | 27 | opts.on("-a", "--api API", "API for benchmarking, example: /homes.json") 28 | 29 | opts.on("-e", "--environment", "default: production") 30 | 31 | opts.on("-t", "--threads [Max Thread]", "Max thread to be used per worker, default: 4") 32 | 33 | opts.on("-w", "--workers [Max Worker]", "Max worker to be used for benchmarking, default: 4") 34 | 35 | opts.on("-d", "--duration [Duration]", "Duration for each test (in seconds), default: 30") 36 | 37 | opts.on("-h", "--help", "Prints this help") do 38 | puts opts 39 | exit 40 | end 41 | end.parse!(into: params) 42 | 43 | run(params) 44 | end 45 | end 46 | end 47 | -------------------------------------------------------------------------------- /lib/puma/benchmark/core.rb: -------------------------------------------------------------------------------- 1 | require 'open3' 2 | require 'pp' 3 | require 'puma/benchmark/print_result' 4 | 5 | module Puma 6 | module Benchmark 7 | class Core 8 | def initialize(params) 9 | @base_url = params[:base_url] || 'http://localhost:3000' 10 | @api = params[:api] 11 | @max_threads = (params[:threads] || 4).to_i 12 | @max_workers = (params[:workers]|| 4).to_i 13 | @duration = params[:duration] || 30 14 | @environment = params[:environment] || 'production' 15 | @result = [] 16 | end 17 | 18 | def current_dir 19 | File.expand_path(File.dirname('.')) 20 | end 21 | 22 | def pid_file 23 | "#{current_dir}/tmp/pids/server.pid" 24 | end 25 | 26 | def run 27 | @max_workers.times do |worker_count| 28 | @max_threads.times do |thread_count| 29 | process(worker_count + 1, thread_count + 1) 30 | end 31 | end 32 | Puma::Benchmark::PrintResult.new.call(@result) 33 | end 34 | 35 | def process(worker_count, thread_count) 36 | if !File.exist?(pid_file) 37 | fork { 38 | system("RAILS_ENV=#{@environment} puma -w #{worker_count} -t #{thread_count}") 39 | } 40 | sleep(5) 41 | end 42 | 43 | print_timer 44 | stdout, stderr, status = Open3.capture3("wrk -t 2 -c 100 -d #{@duration}s #{@base_url}/#{@api}") 45 | pp stdout 46 | 47 | #p "Requests / sec: #{stdout.split(' ')[-3]}" 48 | req_per_sec = stdout.split(' ')[-3] 49 | @result << {workers: worker_count.to_s, threads: thread_count.to_s, req_per_sec: req_per_sec} 50 | system("kill #{File.read(pid_file)}") 51 | sleep(5) 52 | end 53 | 54 | def print_timer 55 | fork{ 56 | p 'Sending request for 30 secs' 57 | 30.times do |n| 58 | print " #{30 - n} sec left \r" 59 | $stdout.flush 60 | sleep(1) 61 | end 62 | } 63 | end 64 | end 65 | end 66 | end -------------------------------------------------------------------------------- /puma-benchmark.gemspec: -------------------------------------------------------------------------------- 1 | 2 | lib = File.expand_path("../lib", __FILE__) 3 | $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) 4 | require "puma/benchmark/version" 5 | 6 | Gem::Specification.new do |spec| 7 | spec.name = "puma-benchmark" 8 | spec.version = Puma::Benchmark::VERSION 9 | spec.authors = ["Anil Maurya"] 10 | spec.email = ["anilmaurya8dec@gmail.com"] 11 | 12 | spec.summary = %q{Benchmark puma requests per sec for different workers and thread count} 13 | spec.description = %q{Benchmark puma requests per sec for different workers and thread count} 14 | spec.homepage = "https://github.com/anilmaurya/puma-benchmark" 15 | spec.license = "MIT" 16 | 17 | # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host' 18 | # to allow pushing to a single host or delete this section to allow pushing to any host. 19 | # if spec.respond_to?(:metadata) 20 | # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'" 21 | 22 | # spec.metadata["homepage_uri"] = spec.homepage 23 | # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here." 24 | # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here." 25 | # else 26 | # raise "RubyGems 2.0 or newer is required to protect against " \ 27 | # "public gem pushes." 28 | # end 29 | 30 | # Specify which files should be added to the gem when it is released. 31 | # The `git ls-files -z` loads the files in the RubyGem that have been added into git. 32 | spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do 33 | `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } 34 | end 35 | spec.bindir = "exe" 36 | spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) } 37 | spec.require_paths = ["lib"] 38 | 39 | spec.add_development_dependency "bundler", "~> 2.0" 40 | spec.add_development_dependency "rake", ">= 12.3.3" 41 | spec.add_development_dependency "minitest", "~> 5.0" 42 | spec.add_development_dependency "pry" 43 | end 44 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Puma::Benchmark 2 | 3 | This gem will help in setting right number of workers and threads for your application. 4 | 5 | ## Installation 6 | 7 | This gem uses `wrk` for benchmarking, therefore you should first install `wrk` on your machine. 8 | For Mac: https://github.com/wg/wrk/wiki/Installing-wrk-on-Mac-OS-X 9 | For Linux: https://github.com/wg/wrk/wiki/Installing-wrk-on-Linux 10 | 11 | Install gem by command: 12 | 13 | $ gem install puma-benchmark 14 | 15 | ## Usage 16 | 17 | Usage: puma-benchmark [options] 18 | 19 | -b, --base_url [BASE_URL] Application base url for 20 | benchmarking, default: http://localhost:3000 21 | 22 | -a, --api API API for benchmarking, example: /homes.json 23 | 24 | -e, --environment default: production 25 | 26 | -t, --threads [Max Thread] Max thread to be used per worker, default: 4 27 | 28 | -w, --workers [Max Worker] Max worker to be used for benchmarking, default: 4 29 | 30 | -d, --duration [Duration] Duration for each test (in seconds), default: 30 31 | 32 | -h, --help Prints this help 33 | 34 | ## Result 35 | 36 | ![result](https://raw.githubusercontent.com/anilmaurya/puma-benchmark/master/puma-benchmark-result.png) 37 | 38 | ## Development 39 | 40 | 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. 41 | 42 | 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). 43 | 44 | ## Contributing 45 | 46 | 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. 47 | 48 | ## License 49 | 50 | The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). 51 | 52 | ## Code of Conduct 53 | 54 | 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). 55 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of experience, 9 | nationality, personal appearance, race, religion, or sexual identity and 10 | orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at anil@joshsoftware.com. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at [http://contributor-covenant.org/version/1/4][version] 72 | 73 | [homepage]: http://contributor-covenant.org 74 | [version]: http://contributor-covenant.org/version/1/4/ 75 | --------------------------------------------------------------------------------