cirron 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c6c65fcba8e45502f5b64fc1ed150c3685ac487d788309d45c81be29a028da2
-  data.tar.gz: b3c3d949d138853c0f5a7bf46fd8fe9ebf83bb957d72d28087b059686a14a122
+  metadata.gz: d920f56abf72180172ea62f52d9c039612353d5238ab75fc9d872549ec486ffb
+  data.tar.gz: 0f3a133a9e2f2ffa6ebc921f951333ed3cc3c89215cbd837edd096e9bf2d50a7
 SHA512:
-  metadata.gz: c9f45039a22835fd70ada492f8ad3bf85358f8186d4088886e52cf7ba8bab3e65fab566c6992a6cc6602ce9b9c7a0b2e1426590a263d414b94aebcf0cffe2c94
-  data.tar.gz: 5aa6c080a082f99090f613f37455a3e3f4afeff43a4e04a303aff42e130fb49a8d413afb8b1223a110dc44087c7ee6dcdaeb7a8f0a08869f924035ba5a038cba
+  metadata.gz: 82a78d5e9644dc363bf17ff83bd9beea08e4bd64ab1033d2cd5b5c1c01d74d7a3c8cdfaecfe49352eebfd858933dac898209b63897bcbe194ac09e3f8f77ad72
+  data.tar.gz: 987c0a0e93683f23b79846aff8fae8a9a2f4c274c66165852311da08cbdcc0b8cea3594ef6d67df9b8b8beaf9657535d8456e69a810dcc5778de5f69bdbdc3fe

data/README.md

@@ -4,53 +4,40 @@ Cirron measures a piece of Ruby code and reports back several performance counte
 CPU instruction count, branch misses, page faults and time spent measuring. 
 It uses the Linux perf events interface or @ibireme's KPC demo[https://gist.github.com/ibireme/173517c208c7dc333ba962c1f0d67d12] on OSX.
 
----
-
 It can also trace syscalls using +strace+, Linux only!
 
----
-
 == Prerequisites
 
 * Linux with perf events support / Apple ARM OSX
 * C++
 * Ruby 3.x
 
----
-
 == Usage
 
 === Performance Counters
-
-  require 'cirron'
+  $ sudo irb
+  irb> require 'cirron'
 
   # Start collecting performance metrics
-  Cirron::Collector.new do |collector|
-    # Your code here
-    # ...
-  end
-
-  # Retrieve the metrics
-  puts collector.counters
-
----
+  irb> counters = Cirron::collector do
+  irb>  # Your code here
+  irb>  puts "Hello"
+  irb> end
+  => Counter(time_enabled_ns: 0, instruction_count: 39066, branch_misses: 546, page_faults: 0)
 
 === Syscalls
 
-  require 'cirron'
-
-  Cirron::Tracer.new do |tracer|
-    # Your code here
-    # ...
-  end
-
-  # Stop collecting and retrieve the trace
-  puts tracer.trace
+  $ sudo irb
+  irb> require 'cirron'
 
+  irb> trace = Cirron::tracer do
+  irb>  # Your code here
+  irb>  puts "Hello"
+  irb> end
+  => [#<Syscall:0x00007c6c1a4b3608 @args="1, [{iov_base=\"Hello\", iov_len=5}, {iov_base=\"\\n\", iov_len=1}], 2", @duration="0.000201", @name="writev", @pid="2261962", @retval="6", @timestamp="1720285300.334976">]
   # Save the trace for ingesting to Perfetto
-  File.write("/tmp/trace", Cirron.to_tef(trace))
-
----
+  irb> File.write("/tmp/trace", Cirron::to_tef(trace))
+  => 267
 
 == Additional Information
 

data/cirron.gemspec

@@ -6,7 +6,7 @@ require 'pathname'
 
 Gem::Specification.new do |spec|
   spec.name = "cirron"
-  spec.version = "0.2.6"
+  spec.version = "0.2.7"
   spec.authors = ["Matt Stuchlik"]
   spec.email = ["matej.stuchlik@gmail.com"]
 

data/lib/tracer.rb

@@ -118,7 +118,7 @@ module Cirron
 
     # Parse the trace file into a list of events
     trace = File.open(trace_file.path, 'r') do |file|
-      parse_strace(trace)
+      parse_strace(file)
     end
 
     trace = filter_trace(trace, trace_file.path + ".dummy")
@@ -128,7 +128,7 @@ module Cirron
     trace
   end
 
-  def to_tef(parsed_events)
+  def self.to_tef(parsed_events)
     events = parsed_events.map do |event|
       case event
       when Syscall

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cirron
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Matt Stuchlik
@@ -13,16 +13,19 @@ dependencies: []
 description: "= Cirron\n\nCirron measures a piece of Ruby code and reports back several
   performance counters: \nCPU instruction count, branch misses, page faults and time
   spent measuring. \nIt uses the Linux perf events interface or @ibireme's KPC demo[https://gist.github.com/ibireme/173517c208c7dc333ba962c1f0d67d12]
-  on OSX.\n\n---\n\nIt can also trace syscalls using +strace+, Linux only!\n\n---\n\n==
-  Prerequisites\n\n* Linux with perf events support / Apple ARM OSX\n* C++\n* Ruby
-  3.x\n\n---\n\n== Usage\n\n=== Performance Counters\n\n  require 'cirron'\n\n  #
-  Start collecting performance metrics\n  Cirron::Collector.new do |collector|\n    #
-  Your code here\n    # ...\n  end\n\n  # Retrieve the metrics\n  puts collector.counters\n\n---\n\n===
-  Syscalls\n\n  require 'cirron'\n\n  Cirron::Tracer.new do |tracer|\n    # Your code
-  here\n    # ...\n  end\n\n  # Stop collecting and retrieve the trace\n  puts tracer.trace\n\n
-  \ # Save the trace for ingesting to Perfetto\n  File.write(\"/tmp/trace\", Cirron.to_tef(trace))\n\n---\n\n==
-  Additional Information\n\nFor more detailed information, please visit the project's
-  GitHub page: https://github.com/s7nfo/Cirron"
+  on OSX.\n\nIt can also trace syscalls using +strace+, Linux only!\n\n== Prerequisites\n\n*
+  Linux with perf events support / Apple ARM OSX\n* C++\n* Ruby 3.x\n\n== Usage\n\n===
+  Performance Counters\n  $ sudo irb\n  irb> require 'cirron'\n\n  # Start collecting
+  performance metrics\n  irb> counters = Cirron::collector do\n  irb>  # Your code
+  here\n  irb>  puts \"Hello\"\n  irb> end\n  => Counter(time_enabled_ns: 0, instruction_count:
+  39066, branch_misses: 546, page_faults: 0)\n\n=== Syscalls\n\n  $ sudo irb\n  irb>
+  require 'cirron'\n\n  irb> trace = Cirron::tracer do\n  irb>  # Your code here\n
+  \ irb>  puts \"Hello\"\n  irb> end\n  => [#<Syscall:0x00007c6c1a4b3608 @args=\"1,
+  [{iov_base=\\\"Hello\\\", iov_len=5}, {iov_base=\\\"\\\\n\\\", iov_len=1}], 2\",
+  @duration=\"0.000201\", @name=\"writev\", @pid=\"2261962\", @retval=\"6\", @timestamp=\"1720285300.334976\">]\n
+  \ # Save the trace for ingesting to Perfetto\n  irb> File.write(\"/tmp/trace\",
+  Cirron::to_tef(trace))\n  => 267\n\n== Additional Information\n\nFor more detailed
+  information, please visit the project's GitHub page: https://github.com/s7nfo/Cirron"
 email:
 - matej.stuchlik@gmail.com
 executables: []