rails_api_benchmark 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bb55b14a6661c98fb64522d6b5fe943c0febdd7
-  data.tar.gz: d8c3b85abd768f3f93824145504d397ac7cad33f
+  metadata.gz: fc553c272bb5f42a3b765748336af37be9503e74
+  data.tar.gz: 6cff65ef9d213d09b809fdc7d3b237a53707e824
 SHA512:
-  metadata.gz: 16d5d896be871a3c49d11a048249177993b07b6ba8c495462b915f8db1854636367127e35a85e1916e6054f875fdd6c94266d39a0f0108c31063d579d15b3dfa
-  data.tar.gz: bd060c86bbc5e8b03cf4432777d19989f5883c70c4685db42c5ff1d2d8923e26ad4b26750a822d18daa078c690f675e2e9c5475c60bbb8277523e2fec4a304ac
+  metadata.gz: 144655c6afb4d8711864152918a5f78e6bbbdc0f2a5d56e61cd59fa62e205eb36c8b8453794a024903d0baf0df9a06acda0a5cd5fb05ffdae260951eec6f7f20
+  data.tar.gz: faeda2140659f2f4d7a509c447ddde94813b770013b997963f1d91ef0651cfb90043f42fd301bc5c30d0960c3888450cb666e3c2cd5d260e8c48b7b2e46ee290

data/README.md

@@ -1,10 +1,59 @@
 # RailsApiBenchmark
 
-Work in progress, yet you can use it like this.
+Work in progress, you can use it like this, see [Important](#important)
 
 ## Usage
 
-Run it with rake api:benchmark
+Run it with:
+```bash
+rails api:benchmark
+```
+
+Display your configuration with:
+```bash
+rails api:benchmark:config
+```
+
+Example output:
+
+```json
+{
+  "concurrency": 2,
+  "host": "localhost:5000",
+  "nb_requests": 1000,
+  "results_folder": "benchmark",
+  "auth_header": "Authorization: Token token=benchToken",
+  "curl_cmd": "curl -H \"%{auth_header}\" http://%{host}%{route}",
+  "bench_cmd": "ab -n %{nb_requests} -c %{concurrency} -g plot.tsv -H \"%{auth_header}\" http://%{host}%{route}",
+  "server_cmd": "bundle exec puma",
+  "env_vars": {
+    "RAILS_MAX_THREADS": "2"
+  },
+  "regexps": [
+    {
+      "key": "response_time",
+      "name": "Average time per request (ms)",
+      "regexp": "(?-mix:Time\\s+per\\s+request:\\s+([0-9.]*).*\\(mean\\))"
+    },
+    {
+      "key": "req_per_sec",
+      "name": "Requests per second (#)",
+      "regexp": "(?-mix:Requests\\s+per\\s+second:\\s+([0-9.]*).*\\(mean\\))"
+    }
+  ],
+  "routes": [
+    {
+      "name": "candidates_per_25",
+      "route": "/candidates",
+      "method": "get",
+      "title": "GET /candidates",
+      "description": "Get first page of candidates (default 25 per page)"
+    }
+  ]
+}
+
+```
+
 
 ## Important
 
@@ -14,73 +63,42 @@ Run it with rake api:benchmark
 
 ## Installation
 
-Install gnuplot (Google)
+* Install gnuplot
+* Install ApacheBench
 
-Add this line to your application's Gemfile:
+For ubuntu:
+```bash
+sudo apt-get install gnuplot
+sudo apt-get install apache2-utils
+```
+* Add this line to your application's Gemfile:
 
 ```ruby
 gem 'rails_api_benchmark'
 ```
 
-And then execute:
+* And then execute:
 ```bash
-$ bundle
+bundle
 ```
 
-Provide necessary configuration in initializer, example config (mine):
+* Provide necessary configuration in initializer, generate it with:
 
-```ruby
-unless Rails.env.production?
-  RailsApiBenchmark.configure do |config|
-    # Try different configs. You may need to run the
-    # benchmark in a production ready environment to get reliable results
-    config.concurrency = 2
-    config.host = 'localhost:5000' # example.com
-    config.nb_requests = 3000
-    config.results_folder = 'benchmark'
-    config.auth_header = 'Authorization: Token token=benchToken'
-    # Use only if you want to log the responses
-    config.curl_cmd = 'curl -H "%{auth_header}" http://%{host}%{route}'
-    # Use Apache Bench
-    config.bench_cmd = 'ab -n %{nb_requests} -c %{concurrency} -g plot.tsv -e plot.csv -H "%{auth_header}" http://%{host}%{route}'
-    config.server_cmd = 'bundle exec puma'
-    config.env_vars = {
-      'RAILS_MAX_THREADS' => '2',
-      'SECRET_KEY_BASE' => 'bench',
-      'RAILS_ENV' => 'production',
-      'SSL_DISABLE' => 'yup',
-      'PORT' => '5000'
-    }
-    config.regexps = [ # Used to get results from the output of benchmark tools
-      {
-        key: :response_time,
-        name: 'Average time per request (ms)',
-        regexp: /Time\s+per\s+request:\s+([0-9.]*).*\(mean\)/
-      }, {
-        key: :req_per_sec,
-        name: 'Requests per second (#)',
-        regexp: /Requests\s+per\s+second:\s+([0-9.]*).*\(mean\)/
-      }
-    ]
-    config.routes = [
-      {
-        name: 'candidates_per_25',
-        route: '/candidates',
-        method: :get,
-        title: 'GET /candidates'
-      }
-    ].freeze
-  end
-end
+```bash
+rails g rails_api_benchmark:config
 ```
 
-Next, add this to your Rakefile:
+* Next, add this to your Rakefile:
 
 ```ruby
 require 'rails_api_benchmark/benchmark_tasks'
 ```
 
-You can now run `rake api:benchmark` !
+You can now run:
+
+```bash
+rails api:benchmark
+```
 
 ## Contributing
 Contributions are welcome
@@ -89,7 +107,7 @@ Contributions are welcome
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
 ### TODO
-* POST requests
-* Create generators (for config initializer first)
+* Summary file (.md), to show response time for each endpoint and compare with others to track the slowest
+* POST requests handling
 * Add simplecov to permit controller coverage for example
-* Generate documentation page(s) (markdown) to list the results
+* Document configuration template file

data/lib/generators/rails_api_benchmark/config_generator.rb

@@ -0,0 +1,22 @@
+module RailsApiBenchmark
+  module Generators
+    # rails g kaminari:config
+    class ConfigGenerator < Rails::Generators::Base # :nodoc:
+      source_root File.expand_path(
+        File.join(
+          File.dirname(__FILE__),
+          'templates'
+        )
+      )
+
+      desc <<-DESC.strip_heredoc
+        Description:
+          Copies RailsApiBenchmark configuration to your app initializers folder
+        DESC
+      def copy_config_file
+        template 'rails_api_benchmark_config.rb',
+                 'config/initializers/rails_api_benchmark_config.rb'
+      end
+    end
+  end
+end

data/lib/generators/rails_api_benchmark/templates/rails_api_benchmark_config.rb

@@ -0,0 +1,41 @@
+# unless Rails.env.production?
+RailsApiBenchmark.configure do |config|
+  # config.concurrency = 2
+  # config.host = 'localhost:5000'
+  # config.nb_requests = 1000
+  # config.results_folder = 'benchmark'
+  # config.auth_header = 'Authorization: Token token=benchToken'
+  # Use only if you want to log the responses
+  # config.curl_cmd = 'curl -H "%{auth_header}" http://%{host}%{route}'
+  # Keep plot.tsv to render graph
+  # config.bench_cmd = 'ab -n %{nb_requests} -c %{concurrency} -g plot.tsv' \
+  #  ' -H "%{auth_header}" http://%{host}%{route}'
+  # config.server_cmd = 'bundle exec puma'
+  # config.env_vars = {
+  # 'RAILS_MAX_THREADS' => '2',
+  # 'SECRET_KEY_BASE' => 'bench',
+  # 'RAILS_ENV' => 'production',
+  # 'PORT' => '5000'
+  # }
+  # config.regexps = [
+  #   {
+  #     key: :response_time,
+  #     name: 'Average time per request (ms)',
+  #     regexp: /Time\s+per\s+request:\s+([0-9.]*).*\(mean\)/
+  #   }, {
+  #     key: :req_per_sec,
+  #     name: 'Requests per second (#)',
+  #     regexp: /Requests\s+per\s+second:\s+([0-9.]*).*\(mean\)/
+  #   }
+  # ]
+  config.routes = [
+    {
+      name: 'todo_list',
+      route: '/todos',
+      method: :get,
+      title: 'GET /todos',
+      description: 'Get first page of todos (default 25 per page)'
+    }
+  ].freeze
+end
+# end

data/lib/rails_api_benchmark/benchmark_tasks.rb

@@ -13,6 +13,15 @@ module RailsApiBenchmark
 
           at_exit { RailsApiBenchmark::Subprocess.kill_all }
         end
+
+        namespace :benchmark do
+          desc 'Prints RailsApiBenchmark config'
+          task config: :environment do
+            require 'json'
+
+            puts JSON.pretty_generate(RailsApiBenchmark.config.all)
+          end
+        end
       end
     end
   end

data/lib/rails_api_benchmark/version.rb

@@ -1,3 +1,3 @@
 module RailsApiBenchmark
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.2.2'.freeze
 end

data/lib/rails_api_benchmark.rb

@@ -8,10 +8,42 @@ require 'rails_api_benchmark/endpoint'
 require 'rails_api_benchmark/views/view' # Requires all the views
 
 module RailsApiBenchmark
-  class Config
+  class Configuration
     attr_accessor :concurrency, :nb_requests, :auth_header,
                   :server_cmd, :bench_cmd, :curl_cmd, :results_folder,
                   :regexps, :env_vars, :routes, :host
+
+    # Default values, INSANE. Must be refactored
+    # Maybe create a yaml or json file to import for default values
+    def initialize
+      self.concurrency = 2
+      self.nb_requests = 1000
+      self.server_cmd = 'bundle exec puma'
+      self.bench_cmd = 'ab -n %{nb_requests} -c %{concurrency} -g plot.tsv' \
+                  ' -H "%{auth_header}" http://%{host}%{route}'
+      self.curl_cmd = 'curl -H "%{auth_header}" http://%{host}%{route}'
+      self.results_folder = 'benchmark'
+      self.regexps = [
+        {
+          key: :response_time,
+          name: 'Average time per request (ms)',
+          regexp: /Time\s+per\s+request:\s+([0-9.]*).*\(mean\)/
+        }, {
+          key: :req_per_sec,
+          name: 'Requests per second (#)',
+          regexp: /Requests\s+per\s+second:\s+([0-9.]*).*\(mean\)/
+        }
+      ]
+      self.env_vars = {
+        'RAILS_MAX_THREADS' => 2,
+        'SSL_DISABLE' => true,
+        'SECRET_KEY_BASE' => '123',
+        'PORT' => 5000
+      }
+      self.routes = []
+      self.host = 'localhost:5000'
+    end
+
     def all
       instance_variables.inject({}) do |h, v|
         var = v.to_s.sub('@', '')
@@ -24,7 +56,7 @@ module RailsApiBenchmark
     attr_writer :config
 
     def config
-      @config ||= Config.new
+      @config ||= Configuration.new
     end
 
     def configure

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_benchmark
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Terry Raimondo
@@ -56,6 +56,8 @@ files:
 - README.md
 - Rakefile
 - gnuplotscript
+- lib/generators/rails_api_benchmark/config_generator.rb
+- lib/generators/rails_api_benchmark/templates/rails_api_benchmark_config.rb
 - lib/rails_api_benchmark.rb
 - lib/rails_api_benchmark/benchmark_tasks.rb
 - lib/rails_api_benchmark/core.rb