ruby-dtrace 0.0.3 → 0.0.4

data/History.txt

@@ -1,3 +1,6 @@
+== 0.0.4 / 2008-01-14
+ * Fix the very basic Rails plugin.
+
 == 0.0.3 / 2008-01-06
 
  * Add a DtraceData class which consumers return, containing

data/Manifest.txt

@@ -32,10 +32,11 @@ plugin/dtrace/bin/dtracer.rb
 plugin/dtrace/init.rb
 plugin/dtrace/lib/dtrace_helper.rb
 plugin/dtrace/lib/dtrace_report.rb
-plugin/dtrace/lib/dtrace_tracer.rb
 plugin/dtrace/lib/dtracer.rb
 plugin/dtrace/lib/dtracer_client.rb
 plugin/dtrace/public/stylesheets/dtrace.css
+plugin/dtrace/scripts/default.d
+plugin/dtrace/scripts/rails_mysql.d
 plugin/dtrace/tasks/dtrace.rake
 plugin/dtrace/test/dtrace_test.rb
 plugin/dtrace/views/dtrace/_report.rhtml

data/lib/dtrace.rb

@@ -63,6 +63,12 @@ require 'dtracedata'
 #   end
 
 class Dtrace
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
+
+  STATUS_NONE    = 0
+  STATUS_OKAY    = 1
+  STATUS_EXITED  = 2
+  STATUS_FILLED  = 3
+  STATUS_STOPPED = 4
 end
 

data/plugin/dtrace/README

@@ -1,4 +1,81 @@
 Dtrace
 ======
 
-Description goes here
+A simple plugin to run a DTrace script while your Rails app runs. 
+
+Installation:
+
+  script/plugin install http://ruby-dtrace.rubyforge.org/svn/trunk/plugin/dtrace
+
+Or copy the plugin/dtrace directory from the installed ruby-dtrace gem
+to your app's vendor/plugins directory. 
+
+Choose a mode of operation:
+
+The process running DTrace needs additional privileges: on Solaris,
+you can grant the dtrace_* privileges, and on both Leopard and Solaris
+you can run the process as root. 
+
+This plugin can run in two modes: you can run the whole app with
+DTrace privileges, or you can run a helper process with the
+privileges, and the app will use DRb to communicate with it.
+
+If you choose to run the app as root, you need to set the :tracer
+option to the dtrace macro to :self, and if you choose to run the
+helper as root, you need to set the :tracer option to :helper. 
+
+Configuring the plugin:
+
+Add the following line to either the specific controller you want
+traced, or to the ApplicationController, in which case it will be
+applied to every controller in your app:
+
+  dtrace :on, :tracer => :self
+
+  or 
+
+  dtrace :on, :tracer => :helper
+
+You can also set the name of the script to be run, from the
+vendor/plugins/dtrace/scripts/ directory with the :script option:
+
+  dtrace :on, :tracer => :self, :script => 'rails_mysql.d'
+
+There are two scripts in the distribution: 
+ * default.d
+    - a very simple script to log system calls, which doesn't require 
+      a DTrace-enabled ruby.
+
+ * rails_mysql.d
+    - a simplified version of the script shown here:
+      http://blogs.sun.com/bmc/entry/dtrace_on_rails, which relies on
+      DTrace-enabled ruby, and the use of MySQL with the
+      libmysqlclient-based adapter, not the pure-ruby adapter.
+
+Troubleshooting:
+
+If you don't get a DTrace report, check the log for messages like:
+
+   DTrace start setup: unable to open dtrace (not root?)
+
+(indicating a lack of privileges to start DTrace: check your setting
+of the :tracer option, and how you are starting the application and/or
+helper).
+
+   DTrace start compile: probe description pid14484::mysql_real_query:entry does not match any probes
+
+(indicating the function mysql_real_query isn't found: either you're
+not using MySQL, or you are using the pure ruby client).
+
+   DTrace start compile: probe description ruby15253:::function-entry does not match any probes
+
+(indicating you are not using a DTrace-enabled ruby binary)
+
+A DRb::DRbConnError reported by Rails, like this:
+
+   druby://localhost:2999 - #<Errno::ECONNREFUSED: Connection refused - connect(2)>
+
+indicates you've selected the :helper option, but the helper isn't
+running. Check that your app can connect to localhost:2999 for the DRb
+service the helper provides.
+

data/plugin/dtrace/bin/dtracer.rb

@@ -20,5 +20,10 @@ require 'dtracer'
 here = "druby://localhost:2999"
 tracer = Dtracer.new
 DRb.start_service here, tracer
-DRb.thread.join
+puts "DTrace helper started"
+begin
+  DRb.thread.join
+rescue Interrupt
+  exit 0
+end
 

data/plugin/dtrace/lib/dtrace_report.rb

@@ -10,34 +10,49 @@ module DtraceReport
   module DtraceMacro
     def dtrace(enable=:on, options={})
       if enable == :on
+
+        # Set tracer type, in-process or helper-process
         if options[:tracer] == :self
-          DtraceReport.tracer = Dtracer.new
+          tracer = Dtracer.new
         elsif options[:tracer] == :helper
-          DtracerReport.tracer = DtracerClient.new
+          tracer = DtracerClient.new
         else
           raise "tracer option is self or helper"
         end
+
+        tracer.logger = logger
+
+        # Set script, or default
+        if options[:script]
+          tracer.script = options[:script]
+        else
+          tracer.script = 'default.d'
+        end
+
+        DtraceReport.tracer = tracer
       end
     end
   end
 
   attr_reader :dtrace_report
+  attr_reader :dtrace_script
 
   protected
   def self.tracer=(tracer)
     @@tracer = tracer
   end
-  
+
   def enable_dtrace
     @@tracer.start_dtrace($$)
   end
 
   def append_dtrace_report
+    @dtrace_script = @@tracer.script
     @dtrace_report = @@tracer.end_dtrace
     # yuck!
     old_template_root = @template.base_path
     begin
-      @template.view_paths = File.join(RAILS_ROOT, 'vendor/plugins/dtrace/views')
+      @template.view_paths =  File.expand_path(File.dirname(__FILE__) + '/../views')
       response.body.gsub!(/<\/body/, @template.render(:partial => 'dtrace/report') + '</body')
     ensure
       @template.view_paths = old_template_root

data/plugin/dtrace/lib/dtracer.rb

@@ -1,84 +1,52 @@
 require 'dtrace'
 
 class Dtracer
-  
-  def start_dtrace(pid)
-    progtext = <<EOD
-self string uri;
-
-pid$1::mysql_real_query:entry
-{
-        @queries[copyinstr(arg1)] = count();
-}
-
-ruby$1:::function-entry
-{
-        @rbclasses[this->class = copyinstr(arg0)] = count();
-        this->sep = strjoin(this->class, "#");
-        @rbmethods[strjoin(this->sep, copyinstr(arg1))] = count();
-}
-
-syscall:::entry
-{
-        @syscalls[probefunc] = count();
-}
-
-END
-{
-        printf("report:syscalls");
-        printa(@syscalls);
-        printf("report:rbclasses");
-        printa(@rbclasses);
-        printf("report:rbmethods");
-        printa(@rbmethods);
-        printf("report:queries");
-        printa(@queries);
-}
+  attr_writer :logger, :dprogram
+  attr_reader :script
 
-EOD
+  def script=(script)
+    @script = script
+    scriptdir = File.expand_path(File.dirname(__FILE__) + "/../scripts")
+    @dprogram = IO.read("#{scriptdir}/#{script}")
+  end
 
+  def start_dtrace(pid)
     begin
       @d = Dtrace.new
       @d.setopt("aggsize", "4m")
       @d.setopt("bufsize", "4m")
     rescue DtraceException => e
-      puts "start setup: #{e.message}"
+      @logger.warn("DTrace start setup: #{e.message}")
       return
     end
 
     begin
-      prog = @d.compile(progtext, pid.to_s)
+      prog = @d.compile(@dprogram, pid.to_s)
       prog.execute
       @d.go
     rescue DtraceException => e
-      puts "start: #{e.message}"
+      @logger.warn("DTrace start compile: #{e.message}")
     end
-
   end
   
   def end_dtrace
-    return {} unless @d
+    # Check presence of handle and correct status.
+    return [] unless @d && @d.status == Dtrace::STATUS_OKAY
 
-    current_report = 'none'
+    dtrace_data = nil
     begin
-      dtrace_report = Hash.new
       c = DtraceConsumer.new(@d)
-      c.consume_once do |e|
-        if e.respond_to? :tuple
-          dtrace_report[current_report][e.tuple.first] = e.value
-        elsif e.respond_to? :value
-          if e.value =~ /report:(.*)/
-            current_report = Regexp.last_match(1)
-            unless dtrace_report[current_report]
-              dtrace_report[current_report] = Hash.new
-            end
-          end
-        end
+      c.consume_once do |d|
+        dtrace_data = d
       end
     rescue DtraceException => e
-      puts "end: #{e.message}"
+      @logger.warn("DTrace end: #{e.message}")
+    end
+    
+    if dtrace_data
+      return dtrace_data.data
+    else
+      return []
     end
-
-    return dtrace_report
   end
 end

data/plugin/dtrace/lib/dtracer_client.rb

@@ -1,12 +1,20 @@
 require 'drb'
 
 class DtracerClient
+  attr_writer :logger
+  attr_reader :script
 
   def initialize
     DRb.start_service
     @tracer = DRbObject.new(nil, 'druby://localhost:2999')  
   end
 
+  def script=(script)
+    @script = script
+    scriptdir = File.expand_path(File.dirname(__FILE__) + "/../scripts")
+    @tracer.dprogram = IO.read("#{scriptdir}/#{script}")
+  end
+
   def start_dtrace(pid)
     @tracer.start_dtrace(pid)
   end
@@ -14,5 +22,5 @@ class DtracerClient
   def end_dtrace
     @tracer.end_dtrace
   end
-  
+
 end

data/plugin/dtrace/scripts/default.d

@@ -0,0 +1,11 @@
+syscall:::entry
+/pid == $1/
+{
+        @syscalls[probefunc] = count();
+}
+
+END
+{
+        printf("System Calls");
+        printa(@syscalls);
+}

data/plugin/dtrace/scripts/rails_mysql.d

@@ -0,0 +1,29 @@
+pid$1::mysql_real_query:entry
+{
+        @queries[copyinstr(arg1)] = count();
+}
+
+ruby$1:::function-entry
+{
+        @rbclasses[this->class = copyinstr(arg0)] = count();
+        this->sep = strjoin(this->class, "#");
+        @rbmethods[strjoin(this->sep, copyinstr(arg1))] = count();
+}
+
+syscall:::entry
+/pid == $1/
+{
+        @syscalls[probefunc] = count();
+}
+
+END
+{
+        printf("MySQL Queries");
+        printa(@queries);
+        printf("System Calls");
+        printa(@syscalls);
+        printf("Ruby Classes");
+        printa(@rbclasses);
+        printf("Ruby Methods");
+        printa(@rbmethods);
+}

data/plugin/dtrace/views/dtrace/_report.rhtml

@@ -1,56 +1,26 @@
 <style type="text/css">
-
+  div#dtrace-report { background-color: #ddd; padding: 1em; margin: 1em; }
+  table.dtrace-report { background-color: #eee }
 </style>
 
+<% if controller.dtrace_report.length > 0 %>
 <div id="dtrace-report">
-  <h2>DTrace Report</h2>
-
-  <% if controller.dtrace_report['queries'] %>
-  <h3>MySQL queries</h3>
-  <table class="report">
-    <% controller.dtrace_report['queries'].sort {|a,b| b[1] <=> a[1] }.each do |e| %>
-    <tr>
-      <td><%= e[0] %></td>
-      <td><%= e[1] %></td>
-    </tr>
-    <% end %>
-  </table>
-  <% end %>
-
-  <% if controller.dtrace_report['syscalls'] %>
-  <h3>System calls</h3>
-  <table class="report">
-    <% controller.dtrace_report['syscalls'].sort {|a,b| b[1] <=> a[1] }.each do |e| %>
-    <tr>
-      <td><%= e[0] %></td>
-      <td><%= e[1] %></td>
-    </tr>
-    <% end %>
-  </table>
-  <% end %>
-
-  <% if controller.dtrace_report['rbclasses'] %>
-  <h3>Ruby classes instantiated</h3>
-  <table class="report">
-    <% controller.dtrace_report['rbclasses'].sort {|a,b| b[1] <=> a[1] }.each do |e| %>
+  <h2>DTrace Report: <%=h controller.dtrace_script %></h2>
+  <% controller.dtrace_report.each do |r| %>
+  <table class="dtrace-report">
+    <% if r.respond_to? :data %>
+    <% r.data.sort {|a,b| b.value <=> a.value }.each do |agg| %>
     <tr>
-      <td><%= e[0] %></td>
-      <td><%= e[1] %></td>
+      <td><%=h agg.tuple %></td>
+      <td><%=h agg.value %></td>
     </tr>
     <% end %>
-  </table>
-  <% end %>
-
-  <% if controller.dtrace_report['rbmethods'] %>
-  <h3>Ruby methods called</h3>
-  <table class="report">
-    <% controller.dtrace_report['rbmethods'].sort {|a,b| b[1] <=> a[1] }.each do |e| %>
-    <tr>
-      <td><%= e[0] %></td>
-      <td><%= e[1] %></td>
-    </tr>
+    <% else %>
+      <% if r.value != 0 %>
+      <h3><%=h r.value %></h3>
+      <% end %>
     <% end %>
   </table>
   <% end %>
-
 </div>
+<% end %>

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: ruby-dtrace
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2008-01-08 00:00:00 +00:00
+  version: 0.0.4
+date: 2008-01-14 00:00:00 +00:00
 summary: Ruby bindings for libdtrace
 require_paths: 
 - lib
@@ -64,10 +64,11 @@ files:
 - plugin/dtrace/init.rb
 - plugin/dtrace/lib/dtrace_helper.rb
 - plugin/dtrace/lib/dtrace_report.rb
-- plugin/dtrace/lib/dtrace_tracer.rb
 - plugin/dtrace/lib/dtracer.rb
 - plugin/dtrace/lib/dtracer_client.rb
 - plugin/dtrace/public/stylesheets/dtrace.css
+- plugin/dtrace/scripts/default.d
+- plugin/dtrace/scripts/rails_mysql.d
 - plugin/dtrace/tasks/dtrace.rake
 - plugin/dtrace/test/dtrace_test.rb
 - plugin/dtrace/views/dtrace/_report.rhtml

data/plugin/dtrace/lib/dtrace_tracer.rb

@@ -1,34 +0,0 @@
-require 'dtrace'
-
-class Dtracer
-  
-  def start_dtrace(pid)
-    @d = Dtrace.new
-    @d.setopt("aggsize", "4m")
-    @d.setopt("bufsize", "4m")
-    progtext = 'ruby$1:::function-entry{ @[strjoin(strjoin(copyinstr(arg0),"."),copyinstr(arg1))] = count(); }'
-    begin
-      prog = @d.compile(progtext, pid.to_s)
-      prog.execute
-      @d.go
-    rescue DtraceException => e
-      puts "start: #{e.message}"
-    end
-  end
-  
-  def end_dtrace(pid)
-    begin
-      @d.stop
-      @d.aggregate_snap
-      
-      dtrace_report = Hash.new
-      @d.each_aggregate do |agg|
-        dtrace_report[agg[1].data] = agg[2].data
-      end
-    rescue DtraceException => e
-      puts "end: #{e.message}"
-    end
-
-    return dtrace_report
-  end
-end