sampling_prof 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: 059734e60c5ca68ae9aee85c3903317177a9e8fd
-  data.tar.gz: dd0da433f98ac0552d97d5053a6de3dca5212db4
-SHA512: 
-  metadata.gz: 0a3bc208fdb609d09ecce6cb69f3577577bf01add12da196ba54e7820a57bfc41670d91abe4a4cf93fbee7242d3061564a2cb71a992019b4460d98b40bb0001f
-  data.tar.gz: 2ad8352836bf838e9b51d6a2de42582a2e9cc315a513d9c36a6150313fb360f1fdc1041605d8c7145f984c28498cbfb08928afcab0c7f2694c4c979fd8d479e7
+---
+SHA1:
+  metadata.gz: 09e40af6cfc090cd8cb6f7898ca0f51caf42c567
+  data.tar.gz: 68069a76e4e43c35e3db126fe40fd60637aab510
+SHA512:
+  metadata.gz: f7aa1b85fe7a29d053f3f10659807f3d7e22bc4479a5115261b23056803082ccc40844f37163956accc6b10b256a451ee7b1a7d4efb7c64999b7de90ff63fcf9
+  data.tar.gz: 53ff7d0f03ca3b510dcba853fdaa9343e7abcf471d55f5d4648f0e9a2b2e665a33cb9a851624ecaba1f4acefefb365b52996ce1181681630524c1cb2e4a8736c

data/README.md

@@ -0,0 +1,101 @@
+SamplingProf
+===============
+
+SamplingProf is a profiling tool that operates by sampling your running thread stacktrace. The result is statistical approximation, but it allows your code to run near full speed.
+
+Quick start
+---------------
+
+For single thread profiling, start with default options:
+
+  prof = SamplingProf.new
+  prof.profile do
+  ... your code ...
+  end
+
+After profiling finished, the output will be write to file SamplingProf::DEFAULT_OUTPUT_FILE
+
+Options
+---------------
+
+SamplingProf class initializer takes 3 arguments:
+
+1. sampling interval: seconds
+2. multithreading: boolean
+3. output interval: seconds
+
+SamplingProf class also takes block as another option to overwite default output handler, the default output handler will write output data to a local file defined by output_file attribute, which is default to SamplingProf::DEFAULT_OUTPUT_FILE
+
+### Sampling interval
+
+This is an interval to control how frequent SamplingProf should take sample of target thread stacktrace.
+The default value is 0.1 seconds.
+
+### Multithreading mode
+
+When running SamplingProf in multithreading environment (e.g. Rails multithreading production environment), you need turn on multithreading mode so that you can profile all requests processing at same time cross threads.
+
+### output interval
+
+Output interval controls how frequent SamplingProf should call output handler to flush out cached data.
+The default value of output interval is depend on the option of multithreading.
+When multithreading is off, the default value is nil, because single thread mode is more likely only need to do once data output when the profiling finished.
+
+When multithreading is on, the default value is 60 seconds, means every 60 seconds SamplingProf will call output handler once to flush out data and restart to cumulate data.
+
+Output data format
+---------------
+
+Output data is divided into a number of chunks. Chunks are separated by 2 "\n" chars.
+
+List of chunks in order:
+
+1. runtime
+2. call element id map
+3. counts
+4. call graph
+
+### runtime chunk
+
+A number represents time of collecting data.
+It should be only one line.
+The time unit is ms.
+Runtime can be used to compute an estimated runtime of a call element.
+
+### call element id map
+
+For storage efficiency, we build this map for counts and call graph chunks to use id instead of a call element string.
+One line one call element string and its id, separated by a comma.
+
+#### call element format
+
+A call element represents a line of code while program running. It has 3 components:
+
+1. file path
+2. line number
+3. method name
+
+A call element string is a join of 3 components with char ":", for example: ./lib/sampling_prof.rb:5:initialize
+
+### counts
+
+SamplingProf collects count of each call element at runtime. There are 2 type of count:
+
+1. self count
+2. total count
+
+Same with call element id map, we use comma to separate data, and one line represents one call element data.
+Here we use call element id instead of call element string to reference the call element.
+The line looks like this: <call element id>,<self count>,<total count>
+
+### call graph
+
+SamplingProf collects counts of function calls. One function call is A call element calls B call element, and B call element calls A call element is considered as another function call.
+
+The call graph stores the counts of function calls.
+Every line is one function call data.
+the line looks like this: <call element id1>,<call element id2>,<count>
+
+Direct recursive calls are recorded as: <call element id1>,<call element id1>,<count>
+
+Indirect recursive calls are ignored as function call only have direct call info. Hence the data maybe odd when there are indirect recursive calls.

data/lib/sampling_prof/internal.rb

@@ -8,10 +8,15 @@ class SamplingProf
       @call_graph = Hash.new{|h,k| h[k] = 0}
       @nodes = {}
       @threads = threads
+      @start_at = Time.now
+    end
+
+    def runtime
+      Time.now - @start_at
     end
 
     def result
-      ret = []
+      ret = [runtime * 1000]
       ret << @nodes.map {|node| node.join(',')}.join("\n")
       ret << @samples.map {|count| count.flatten.join(',')}.join("\n")
       ret << @call_graph.map {|v| v.flatten.join(',')}.join("\n")
@@ -92,11 +97,10 @@ class SamplingProf
       @sampling_thread ||= Thread.start do
         loop do
           sampling = Sampling.new(@threads)
-          start_time = Time.now
           loop do
             break unless @running
             if @multithreading
-              break if output_interval < (Time.now - start_time)
+              break if output_interval < sampling.runtime
             end
             sampling.process
             sleep @sampling_interval

data/lib/sampling_prof.rb

@@ -46,7 +46,7 @@ class SamplingProf
   end
 
   def report(type, output=$stdout)
-    nodes, counts, call_graph = File.read(output_file).split("\n\n")
+    runtime, nodes, counts, call_graph = File.read(output_file).split("\n\n")
     nodes = nodes.split("\n").inject({}) do |ret, l|
       n, i = l.split(',')
       ret[i.to_i] = n
@@ -58,6 +58,7 @@ class SamplingProf
     end
     total_samples, report = flat_report(nodes, counts)
 
+    output.puts "runtime: #{runtime.to_f/1000} secs"
     output.puts "total samples: #{total_samples}"
     output.puts "self\t%\ttotal\t%\tname"
     report.first(20).each do |v|

metadata

@@ -1,70 +1,69 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sampling_prof
-version: !ruby/object:Gem::Version 
-  version: 0.2.1
+version: !ruby/object:Gem::Version
+  version: 0.3.0
 platform: ruby
-authors: 
-  - Xiao Li
+authors:
+- Xiao Li
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-03-23 00:00:00 Z
-dependencies: 
-  - !ruby/object:Gem::Dependency 
-    name: rake-compiler
-    prerelease: false
-    requirement: &id001 !ruby/object:Gem::Requirement 
-      requirements: 
-        - - ~>
-          - !ruby/object:Gem::Version 
-            version: "0.9"
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: 0.9.2
-    type: :development
-    version_requirements: *id001
+date: 2014-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 description: |
   SamplingProf is a profiling tool that operates by sampling your running thread stacktrace. The result is statistical approximation, but it allows your code to run near full speed
-
-email: 
-  - swing1979@gmail.com
+email:
+- swing1979@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-  - README.md
-  - lib/sampling_prof.jar
-  - lib/sampling_prof.rb
-  - lib/sampling_prof/internal.rb
+files:
+- README.md
+- lib/sampling_prof.jar
+- lib/sampling_prof.rb
+- lib/sampling_prof/internal.rb
 homepage: https://github.com/xli/sampling_prof
-licenses: 
-  - MIT
+licenses:
+- MIT
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
-  - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-    - &id002 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-    - *id002
+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: []
-
 rubyforge_project: 
-rubygems_version: 2.1.9
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Simple sampling profiler for ruby
 test_files: []
-