owl_tracer 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d0588e86dbb24affa977b1962b80ce59cd0d178
-  data.tar.gz: 1aaacd500684f8fc7e08f56cf08f1456de59f1f9
+  metadata.gz: c64ba3066ebfd34cc6fcd4127138d05a1085c61e
+  data.tar.gz: 3d244f622b1193cb39fc9be7428091394ba901cc
 SHA512:
-  metadata.gz: c5ee34312717a42036ff72c34eee1e73f2c8b574aa2e1bb66b409f2a1148eadf53ba391bc1f28476056b063e5ef6e3c526783ab99d1cf2ffb8a66fbd71e80363
-  data.tar.gz: c34d2bd208df8deb1b3c61bd4545829503a19f9414057a1f8cbf7854c3e84214309032b16d5057a9335ff0c061685ac147a498084cfa305dc5fb081fe386dd09
+  metadata.gz: d57d0b92e9572fd4a0cba956c7303e18d94250e4da12a73a0a83d7085f250b786747e9e5c546fe21686d7f7615929d81948c7b3aa749716f72ca1f24fa8b56ce
+  data.tar.gz: 719ecd38bd50bc4a48076095350f44fda7d459e5b0f1ded57c44a9456c6151d50616e20e0534b425731f1cad8bb469ba0211f22e4a2881f40f38ab79d92a04f5

data/README.md

@@ -0,0 +1,105 @@
+Easy to use performance tracer for Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'owl_tracer'
+```
+
+## Usage
+
+Step 1, instantiate the tracer:
+```
+tracer = OwlTracer.new
+```
+
+Step 2, run whatever code you want to benchmark. Let's say we run two commands:
+```
+review_presenter.prepare
+stats_calcularor.calc
+```
+
+Step 3, get the results:
+```
+pp tracer.dump_results(100) # Only calls that took at least 100ms will be reported
+```
+and you'll receive an array of strings with all your application method calls with how many milliseconds it took to run, properly idented. It will look like this:
+```
+ReviewPresenter::prepare (1273 ms)
+  ChildPresenter::initialize (1047 ms)
+    ChildPresenter::initialize_pricing_instance_variables (260 ms)
+      ChildPresenter::initialize_quoted_rate_presenter (203 ms)
+    IncomePresenter::initialize_income_presenter (260 ms)
+      JobPresenter::initialize (238 ms)
+        Review::JobVerifier::initialize (238 ms)
+          Review::JobVerifier::load_jobs (130 ms)
+StatsCalculator::calc (118 ms)
+```
+
+You can also skip the number of milliseconds or pass 0 and this will produce a very verbose list of all method calls that happened between the tracer was instantiated until you asked for the dump.
+The first time you call `dump_results`, it stops recording new calls, but you can call `dump_results` multiple times with a different number to zoom in or out what was recorded.
+
+## Web Usage
+To figure out why some route is slow in your application, just add this to your app's `application_controller`:
+
+```
+class ApplicationController < ActionController::Base
+  ...
+  around_action :owl_tracer_logger
+  ...
+  
+    def global_request_logging
+      # if a param comes in the request, we start the tracer
+      if params[:owl_tracer] 
+        tracer = OwlTracer.new
+      end  
+
+      # we let the request be hadled normally
+      yield
+  
+      if params[:owl_tracer]
+        # get the results
+        trace_result = tracer.dump_results(params[:owl_tracer].to_i)
+        
+        # them write it to a log file
+        File.write("/tmp/owl_tracer.txt", trace_result.join("\n"))
+        
+        # or print it in the logs
+        warn(trace_result)
+        
+        # or email it to you... or save it on S3... etc.
+      end
+  end
+```
+
+after that, you can just do `http://your_server/whatever_endpoint_you_want?owl_tracer=200` to get everything that is taking more than `200ms` , including both controller time, rendering time and code triggered by the view time, like:
+
+```
+SlowController::show (1073 ms)
+  PastPresenter::initialize (1047 ms)
+    PastPresenter::initialize_pricing_instance_variables (260 ms)
+      PastPresenter::initialize_quoted_rate_PastPresenter (203 ms)
+    PastPresenter::initialize_income_PastPresenter (260 ms)
+      JobPastPresenter::initialize (238 ms)
+        Slow::JobVerifier::initialize (238 ms)
+show.html.slim::rendering (2474 ms)
+  _summary.html.slim::rendering (1842 ms)
+    _collapse_panels.html.slim::rendering (549 ms)
+      _Education_panel.html.slim::rendering (389 ms)
+        EducationPresenter::data_json (386 ms)
+          EducationPresenter::data_hash (345 ms)
+            EducationPresenter::verifications (306 ms)
+    sHelper::_supportables (225 ms)
+      #<Class:SupportingDocs::SupportableServicer>::get_all_doc_supportables (225 ms)
+  _tabs.html.slim::rendering (558 ms)
+    _info_tab.html.slim::rendering (427 ms)
+      _education_info.html.slim::rendering (261 ms)
+        _bank_info.html.slim::rendering (217 ms)
+```
+
+### and now you know why that routs is slow! :-)
+
+
+

data/owl_tracer.gemspec

@@ -1,15 +1,15 @@
 Gem::Specification.new do |s|
   s.name          = "owl_tracer"
-  s.version       = "0.0.2"
+  s.version       = "0.0.3"
   s.date          = "2016-11-05"
   s.summary       = "Easy to use performance tracer for Ruby"
-  s.description   = "Logs how much time each method call is taking and returns an idented list"
+  s.description   = "Easy to use performance tracer for Ruby"
   s.authors       = ["Gui Carvalho"]
   s.email         = "guilherme@konkix.com"
   s.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test/|\.gitignore|\.travis)})
   end
-  s.require_paths = ['lib']
+  s.require_paths = ["lib"]
   s.homepage      = "https://github.com/guimonz/owl_tracer"
   s.license       = "MIT"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: owl_tracer
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Gui Carvalho
@@ -10,8 +10,7 @@ bindir: bin
 cert_chain: []
 date: 2016-11-05 00:00:00.000000000 Z
 dependencies: []
-description: Logs how much time each method call is taking and returns an idented
-  list
+description: Easy to use performance tracer for Ruby
 email: guilherme@konkix.com
 executables: []
 extensions: []
@@ -19,9 +18,8 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - Gemfile.lock
-- README
+- README.md
 - lib/owl_tracer.rb
-- owl_tracer-0.0.1.gem
 - owl_tracer.gemspec
 homepage: https://github.com/guimonz/owl_tracer
 licenses:

data/README

@@ -1,2 +0,0 @@
-
-