corn 0.5.5 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 759ed8b4825185d198f5ac578d23004bd8569724
-  data.tar.gz: 8a9d9cdf4085189b76c7177c01e05fff8c758b52
+  metadata.gz: 2128d61b559f2364bb060b87e258069ed0573622
+  data.tar.gz: 84dadacc4a71ad7b6c33209ef3cf1c5829e91936
 SHA512:
-  metadata.gz: 005c5d90a218768e58b7f392158891961488715067994c7bd470f56380814434f8657b3453a277677dc367dd7f3b0db76006ac0a3876e77c63c99dad22d8cd43
-  data.tar.gz: 617f8d391b4fe3f864e1b19ce7c9b5f10f3281b8fd7e7107478dab66ccffb3c617e4cc9f52ebe9622cbaf5f27e292a9c9e3542b3d4bf91c84190111d8ca8f420
+  metadata.gz: fa94880e60a3bf2e53e8901fc13e62d74424708c67d1f0c9848bbc63bcf825fc5c286298ca3ea0da847a315cc516fbb075ead74f4f1fd881ce17d4d3ee5a1ac0
+  data.tar.gz: 7791a5595a58ac89cf35ec041112ee78999e14f17665f8adf168f8f32b3bb78f28b75d2e3dc7f46ac58f7a4ecad7a612f88a4bc5ebe105a57c3c3857d46a9713

data/lib/corn/config.rb

@@ -18,9 +18,9 @@ module Corn
             end
             q = !!value == value ? '?' : ''
             self.class_eval <<-RUBY, __FILE__, __LINE__
-              def self.#{key}#{q}
+              def self.#{key}#{q}(*args)
                 r = @config[:#{key}]
-                r.is_a?(Proc) ? r.call : r
+                r.is_a?(Proc) ? r.call(*args) : r
               end
             RUBY
           end

data/lib/corn/rack/request_env.rb

@@ -1,8 +1,9 @@
 module Corn
   module Rack
     class RequestEnv
+      KEYS = [:request_method, :path_info, :http_host, :query_string]
       def initialize(env, start_time=Time.now)
-        @env = [:path_info, :http_host, :query_string].inject({}) do |memo, k|
+        @env = KEYS.inject({}) do |memo, k|
           v = env[k.to_s.upcase]
           if v.nil? || v.empty?
             memo
@@ -23,6 +24,9 @@ module Corn
 
       def to_report
         name = File.join(@env[:http_host].to_s, @env[:path_info].to_s)
+        if @env[:request_method]
+          name = "#{@env[:request_method]} #{name}"
+        end
         if @env[:query_string]
           name = "#{name}?#{@env[:query_string]}"
         end

data/lib/corn/rack/slow_request_profiler.rb

@@ -9,10 +9,12 @@ module Corn
           @@prof ||= Profiler.new(Corn.post_interval,
                                   Corn.sampling_interval)
           @app = app
+          Corn.logger.info("Corn sampling interval: #{Corn.sampling_interval}")
+          Corn.logger.info("Corn slow request threshold: #{Corn.slow_request_threshold}")
         end
 
         def call(env)
-          if Corn.profiling?
+          if Corn.profiling?(env)
             @@prof.profile(output_handler(env)) { @app.call(env) }
           else
             @app.call(env)

data/lib/generators/corn/config/config_generator.rb

@@ -6,14 +6,60 @@ module Corn
       def do_config
         create_file "config/initializers/corn_config.rb", <<-RUBY
 Corn.config({
+              # setup Corn logger, default is output to STDOUT.
               :logger => Rails.logger,
+
+              # Every Corn project has its own client id, you can find it in your
+              # Corn project page. This is a unique identifier for reporting your
+              # data, please keep it secret.
               # :client_id => ENV["CORN_CLIENT_ID"],
+
+              # Corn only reprots requests that are exceeded this threshold;
+              # default threshold is 5 seconds. Please use your 97 percentile response
+              # time as slow_request_threshold value, so that you can focus on
+              # improving slow requests. Doing nothing with generated reports
+              # is a waste.
+              # You can change this value to 0 for testing Corn configurations,
+              # and learn how Corn works.
+              # Set this threshold to smaller value may cause performance overhead.
               # :slow_request_threshold => 5,
+
+              # Sampling interval controls how frequent profiler should take
+              # sample of processing request threads' stacktrace. The default value
+              # is 0.1 seconds. Change the value to larger number will reduce the
+              # performance impact to your application. Change the value to smaller
+              # number will increase performance impact.
+              # The more samples we have for processing a request, the more accurate
+              # of the profiling call-graph report we will have.
+              # Hence it needs a balance.
+              # For example, when a request processing time is 5 seconds, sampling_interval
+              # value is 0.1 second, then we will get approximately 50 samples, which
+              # is good enough for you to understand what's your code doing in most
+              # of cases.
               # :sampling_interval => 0.1,
+
+              # Corn launchs a standalone thread to post profiling data back to Corn server.
+              # post_interval controls how frequent we will post one report back to
+              # Corn server. Default value is 2 seconds. It means the posting thread will
+              # sleep 2 seconds after Corn posted one processed slow request profiling
+              # data to Corn server. If you had too many reports need to be posted to Corn
+              # server, we recommend you increase slow_request_threshold instead of reduce
+              # post_interval value.
               # :post_interval => 2,
+
+              # Why we need this configuration? The anwser is runtime toggle.
+              # You may like to turn off the Corn profiler in most of time,
+              # and only turn on profiling when you need it in production.
+              # The value can be "true", "false" or a lambda (or Proc).
+              # For example: Corn.config(:profiling => lambda {|env| YourAppConfig.corn_profiling? })
+              # The "env" argument is the Rack env argument when a Rack middleware is
+              # called. So you can also use it to turn on profiling by a request parameter.
+              # For example: Corn.config(:profiling => lambda {|env| env["QUERY_STRING"] =~ /corn_profiling=true/ })
+              # This configuration will be checked for every request, so don't do anything
+              # expense here.
               # :profiling => true,
             })
-
+# Install corn rack middleware for profiling slow requests
 Rails.configuration.middleware.use(Corn.rack_middleware)
 RUBY
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: corn
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.6
 platform: ruby
 authors:
 - Xiao Li
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-07-04 00:00:00.000000000 Z
+date: 2014-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sampling_prof