mmtrix_rpm 1.0.0.1

data/test/test_helper.rb

@@ -0,0 +1,266 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+module Mmtrix; TEST = true; end unless defined? Mmtrix::TEST
+ENV['RAILS_ENV'] = 'test'
+MMTRIX_PLUGIN_DIR = File.expand_path(File.join(File.dirname(__FILE__),".."))
+$LOAD_PATH << '.'
+$LOAD_PATH << '../../..'
+$LOAD_PATH << File.join(MMTRIX_PLUGIN_DIR,"lib")
+$LOAD_PATH << File.join(MMTRIX_PLUGIN_DIR,"test")
+$LOAD_PATH << File.join(MMTRIX_PLUGIN_DIR,"ui/helpers")
+$LOAD_PATH.uniq!
+
+require 'rubygems'
+require 'rake'
+
+require 'minitest/autorun'
+require 'mocha/setup'
+
+unless defined?(Minitest::Test)
+  Minitest::Test = MiniTest::Unit::TestCase
+end
+
+require 'hometown'
+Hometown.watch(::Thread)
+
+# Set up a watcher for leaking agent threads out of tests.  It'd be nice to
+# disable the threads everywhere, but not all tests have mmtrix.yml loaded to
+# us to rely on, so instead we'll just watch for it.
+class Minitest::Test
+  def before_setup
+    if self.respond_to?(:name)
+      test_method_name = self.name
+    else
+      test_method_name = self.__name__
+    end
+
+    Mmtrix::Agent.logger.info("*** #{self.class}##{test_method_name} **")
+
+    @__thread_count = ruby_threads.count
+    super
+  end
+
+  def after_teardown
+    unfreeze_time
+
+    threads = ruby_threads
+    if @__thread_count != threads.count
+      backtraces = threads.map do |thread|
+        trace = Hometown.for(thread)
+        trace.backtrace.join("\n    ")
+      end.join("\n\n")
+
+      fail "Thread count changed in this test from #{@__thread_count} to #{threads.count}\n#{backtraces}"
+    end
+
+    super
+  end
+
+  # We only want to count threads that were spun up from Ruby (i.e.
+  # Thread.new) JRuby has system threads we don't care to track.
+  def ruby_threads
+    Thread.list.select { |t| Hometown.for(t) }
+  end
+end
+
+Dir.glob('test/helpers/*').each { |f| require f }
+
+Dir.glob(File.join(MMTRIX_PLUGIN_DIR,'test/helpers/*.rb')).each do |helper|
+  require helper
+end
+
+# We can speed things up in tests that don't need to load rails.
+# You can also run the tests in a mode without rails.  Many tests
+# will be skipped.
+if ENV["NO_RAILS"]
+  puts "Running tests in standalone mode without Rails."
+  require 'mmtrix_rpm'
+else
+  begin
+    require 'config/environment'
+    require 'mmtrix_rpm'
+  rescue LoadError
+    puts "Running tests in standalone mode."
+
+    require 'bundler'
+    Bundler.require
+
+    require 'rails/all'
+    require 'mmtrix_rpm'
+
+    # Bootstrap a basic rails environment for the agent to run in.
+    class MyApp < Rails::Application
+      config.active_support.deprecation = :log
+      config.secret_token = "49837489qkuweoiuoqwehisuakshdjksadhaisdy78o34y138974xyqp9rmye8yrpiokeuioqwzyoiuxftoyqiuxrhm3iou1hrzmjk"
+      config.after_initialize do
+        Mmtrix::Agent.manual_start
+      end
+    end
+    MyApp.initialize!
+  end
+end
+
+# This is the public method recommended for plugin developers to share our
+# agent helpers. Use it so we don't accidentally break it.
+Mmtrix::Agent.require_test_helper
+
+def default_service(stubbed_method_overrides = {})
+  service = stub
+  stubbed_method_defaults = {
+    :connect => {},
+    :shutdown => nil,
+    :agent_id= => nil,
+    :agent_id => nil,
+    :collector => stub_everything,
+    :request_timeout= =>  nil,
+    :metric_data => nil,
+    :error_data => nil,
+    :transaction_sample_data => nil,
+    :sql_trace_data => nil,
+    :get_agent_commands => [],
+    :agent_command_results => nil,
+    :analytic_event_data => nil,
+    :valid_to_marshal? => true
+  }
+
+  service.stubs(stubbed_method_defaults.merge(stubbed_method_overrides))
+
+  # When session gets called yield to the given block.
+  service.stubs(:session).yields
+  service
+end
+
+def with_verbose_logging
+  orig_logger = Mmtrix::Agent.logger
+  $stderr.puts '', '---', ''
+  new_logger = Mmtrix::Agent::AgentLogger.new('', Logger.new($stderr) )
+  Mmtrix::Agent.logger = new_logger
+
+  with_config(:log_level => 'debug') do
+    yield
+  end
+ensure
+  Mmtrix::Agent.logger = orig_logger
+end
+
+# Need to be a bit sloppy when testing against the logging--let everything
+# through, but check we (at least) get our particular message we care about
+def expects_logging(level, *with_params)
+  ::Mmtrix::Agent.logger.stubs(level)
+  ::Mmtrix::Agent.logger.expects(level).with(*with_params).once
+end
+
+def expects_no_logging(level)
+  ::Mmtrix::Agent.logger.expects(level).never
+end
+
+# Sometimes need to test cases where we muddle with the global logger
+# If so, use this method to ensure it gets restored after we're done
+def without_logger
+  logger = ::Mmtrix::Agent.logger
+  ::Mmtrix::Agent.logger = nil
+  yield
+ensure
+  ::Mmtrix::Agent.logger = logger
+end
+
+def fixture_tcp_socket( response )
+  # Don't actually talk to Google.
+  socket = stub("socket") do
+    stubs(:closed?).returns(false)
+    stubs(:close)
+    stubs(:setsockopt)
+
+    # Simulate a bunch of socket-ey stuff since Mocha doesn't really
+    # provide any other way to do it
+    class << self
+      attr_accessor :response, :write_checker
+    end
+
+    def self.check_write
+      self.write_checker = Proc.new
+    end
+
+    def self.write( buf )
+      self.write_checker.call( buf ) if self.write_checker
+      buf.length
+    end
+
+    def self.sysread( size, buf='' )
+      @data ||= response.to_s
+      raise EOFError if @data.empty?
+      buf.replace @data.slice!( 0, size )
+      buf
+    end
+    class << self
+      alias_method :read_nonblock, :sysread
+    end
+
+  end
+
+  socket.response = response
+  TCPSocket.stubs( :open ).returns( socket )
+
+  return socket
+end
+
+def dummy_mysql_explain_result(hash=nil)
+  hash ||= {
+    'Id' => '1',
+    'Select Type' => 'SIMPLE',
+    'Table' => 'sandwiches',
+    'Type' => 'range',
+    'Possible Keys' => 'PRIMARY',
+    'Key' => 'PRIMARY',
+    'Key Length' => '4',
+    'Ref' => '',
+    'Rows' => '1',
+    'Extra' => 'Using index'
+  }
+  explain_result = mock('explain result')
+  explain_result.stubs(:each_hash).yields(hash)
+  explain_result
+end
+
+module TransactionSampleTestHelper
+  module_function
+  def make_sql_transaction(*sql)
+    sampler = nil
+    state = Mmtrix::Agent::TransactionState.tl_get
+
+    in_transaction('/path') do
+      sampler = Mmtrix::Agent.instance.transaction_sampler
+      sampler.notice_push_frame(state, "a")
+      explainer = Mmtrix::Agent::Instrumentation::ActiveRecord::EXPLAINER
+      sql.each {|sql_statement| sampler.notice_sql(sql_statement, {:adapter => "mysql"}, 0, state, explainer) }
+      sleep 0.02
+      yield if block_given?
+      sampler.notice_pop_frame(state, "a")
+    end
+
+    return sampler.last_sample
+  end
+
+  def run_sample_trace(path='/path')
+    sampler = nil
+    state = Mmtrix::Agent::TransactionState.tl_get
+
+    request = stub(:path => path)
+
+    in_transaction("Controller/sandwiches/index", :request => request) do
+      sampler = Mmtrix::Agent.instance.transaction_sampler
+      sampler.notice_sql("SELECT * FROM sandwiches WHERE bread = 'wheat'", {}, 0, state)
+      sampler.notice_push_frame(state, "ab")
+      sampler.notice_sql("SELECT * FROM sandwiches WHERE bread = 'white'", {}, 0, state)
+      yield sampler if block_given?
+      sampler.notice_pop_frame(state, "ab")
+      sampler.notice_push_frame(state, "lew")
+      sampler.notice_sql("SELECT * FROM sandwiches WHERE bread = 'french'", {}, 0, state)
+      sampler.notice_pop_frame(state, "lew")
+    end
+
+    return sampler.last_sample
+  end
+end

data/ui/helpers/developer_mode_helper.rb

@@ -0,0 +1,324 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+require 'pathname'
+require File.expand_path('../google_pie_chart', __FILE__)
+require 'mmtrix/collection_helper'
+require 'mmtrix/metric_parser/metric_parser'
+module Mmtrix::DeveloperModeHelper
+  include Mmtrix::CollectionHelper
+
+  private
+
+  # limit of how many detail/SQL rows we display - very large data sets (~10000+) crash browsers
+  def trace_row_display_limit
+    2000
+  end
+
+  def trace_row_display_limit_reached
+   (!@detail_node_count.nil? && @detail_node_count > trace_row_display_limit) || sql_segments(@sample).length > trace_row_display_limit
+  end
+
+  # return the highest level in the call stack for the trace that is not rails or
+  # mmtrix agent code
+  def application_caller(trace)
+    trace = strip_nr_from_backtrace(trace) unless params[:show_nr]
+    trace.each do |trace_line|
+      file, _line, gem = file_and_line(trace_line)
+      unless file && exclude_file_from_stack_trace?(file, false, gem)
+        return trace_line
+      end
+    end
+    trace.last
+  end
+
+  def application_stack_trace(trace, include_rails = false)
+    trace = strip_nr_from_backtrace(trace) unless params[:show_nr]
+    trace.reject do |trace_line|
+      file, _line, gem = file_and_line(trace_line)
+      file && exclude_file_from_stack_trace?(file, include_rails, gem)
+    end
+  end
+
+  def render_backtrace
+    if @segment[:backtrace]
+      content_tag('h3', 'Application Stack Trace') +
+      render(:partial => 'stack_trace')
+    end
+  end
+
+  def h(text)
+    text
+  end
+
+  def agent_views_path(path)
+    path
+  end
+
+  def dev_name(metric_name)
+    Mmtrix::MetricParser::MetricParser.parse(metric_name).developer_name
+  end
+
+  # write the metric label for a segment metric in the detail view
+  def write_segment_label(segment)
+    link_to_function(dev_name(segment.metric_name), "toggle_row_class($(this).closest('td').find('a')[0])")
+  end
+
+  # write the metric label for a segment metric in the summary table of metrics
+  def write_summary_segment_label(segment)
+    dev_name(segment.metric_name)
+  end
+
+  def write_stack_trace_line(trace_line)
+    trace_line
+  end
+
+  # print the formatted timestamp for a segment
+  def timestamp(segment)
+    sprintf("%1.3f", segment.entry_timestamp)
+  end
+
+  def format_timestamp(time)
+    time.strftime("%H:%M:%S")
+  end
+
+  def colorize(value, yellow_threshold = 0.05, red_threshold = 0.15, s=to_ms(value))
+    if value > yellow_threshold
+      color = (value > red_threshold ? 'red' : 'orange')
+      "<font color=#{color}>#{s}</font>"
+    else
+      "#{s}"
+    end
+  end
+
+  def expanded_image_path()
+    '/mmtrix/file/images/arrow-open.png'
+  end
+
+  def collapsed_image_path()
+    '/mmtrix/file/images/arrow-close.png'
+  end
+
+  def explain_sql_url(segment)
+    "explain_sql?id=#{@sample.sample_id}&amp;segment=#{segment.object_id}"
+  end
+
+  def segment_duration_value(segment)
+    link_to colorize(segment.duration, 0.05, 0.15, "#{with_delimiter(to_ms(segment.duration))} ms"), explain_sql_url(segment)
+  end
+
+  def line_wrap_sql(sql)
+    sql.gsub(/\,/,', ').squeeze(' ') if sql
+  end
+
+  def render_sample_details(sample)
+    @indentation_depth=0
+    # skip past the root segments to the first child, which is always the controller
+    first_segment = sample.root_node.called_nodes.first
+
+    # render the segments, then the css classes to indent them
+    render_segment_details(first_segment).to_s + render_indentation_classes(@indentation_depth).to_s
+  end
+
+  # the rows logger plugin disables the sql tracing functionality of the Mmtrix agent -
+  # notify the user about this
+  def rows_logger_present?
+    File.exist?(File.join(File.dirname(__FILE__), "../../../rows_logger/init.rb"))
+  end
+
+  def expand_segment_image(segment, depth)
+    if depth > 0
+      if !segment.called_nodes.empty?
+        row_class =segment_child_row_class(segment)
+        link_to_function("<img src=\"#{collapsed_image_path}\" id=\"image_#{row_class}\" class_for_children=\"#{row_class}\" class=\"#{(!segment.called_nodes.empty?) ? 'parent_segment_image' : 'child_segment_image'}\" />", "toggle_row_class(this)")
+      end
+    end
+  end
+
+  def segment_child_row_class(segment)
+    "segment#{segment.object_id}"
+  end
+
+  def summary_pie_chart(sample, width, height)
+    pie_chart = GooglePieChart.new
+    pie_chart.color, pie_chart.width, pie_chart.height = '6688AA', width, height
+
+    chart_data = breakdown_data(sample, 6)
+    chart_data.each { |s| pie_chart.add_data_point dev_name(s.metric_name), to_ms(s.exclusive_time) }
+
+    pie_chart.render
+  end
+
+  def segment_row_classes(segment, depth)
+    classes = []
+
+    classes << "segment#{segment.parent_node.object_id}" if depth > 1
+    classes << "view_segment" if segment.metric_name.index('View') == 0
+
+    classes.join(' ')
+  end
+
+  # render_segment_details should be called before calling this method
+  def render_indentation_classes(depth)
+    styles = []
+     (1..depth).each do |d|
+      styles <<  ".segment_indent_level#{d} { display: inline-block; margin-left: #{(d-1)*20}px }"
+    end
+    content_tag("style", styles.join(' '))
+  end
+
+  def sql_link_mouseover_options(segment)
+    { :onmouseover => "sql_mouse_over(#{segment.object_id})", :onmouseout => "sql_mouse_out(#{segment.object_id})"}
+  end
+
+  def explain_sql_link(segment, child_sql = false)
+    link_to 'SQL', explain_sql_url(segment)+ '"' + sql_link_mouseover_options(segment).map {|k,v| "#{k}=\"#{v}\""}.join(' ')+ 'fake=\"'
+  end
+
+  def explain_sql_links(segment)
+    if segment[:sql]
+      explain_sql_link segment
+    else
+      links = []
+      segment.called_nodes.each do |child|
+        if child[:sql]
+          links << explain_sql_link(child, true)
+        end
+      end
+      links[0..1].join(', ') + (links.length > 2?', ...':'')
+    end
+  end
+
+  private
+  # return three objects, the file path, the line in the file, and the gem the file belongs to
+  # if found
+  def file_and_line(stack_trace_line)
+    if stack_trace_line =~ /^(?:(\w+) \([\d.]*\) )?(.*):(\d+)/
+      return $2, $3, $1
+    else
+      return nil
+    end
+  end
+
+  def render_segment_details(segment, depth=0)
+    @detail_node_count ||= 0
+    @detail_node_count += 1
+
+    return '' if @detail_node_count > trace_row_display_limit
+
+    @indentation_depth = depth if depth > @indentation_depth
+    repeat = nil
+    html = render(:partial => 'segment', :object => [segment, depth, repeat])
+    depth += 1
+
+    segment.called_nodes.each do |child|
+      html << render_segment_details(child, depth)
+    end
+
+    html
+  end
+
+  def exclude_file_from_stack_trace?(file, include_rails, gem=nil)
+    return false if include_rails
+    return true if file !~ /\.(rb|java)/
+    return true if %w[rack activerecord activeresource activesupport actionpack railties].include? gem
+    %w[/actionmailer/
+             /activerecord
+             /activeresource
+             /activesupport
+             /lib/mongrel
+             /actionpack
+             /passenger/
+             /railties
+             benchmark.rb].each { |s| return true if file.include? s }
+     false
+  end
+
+  def show_view_link(title, page_name)
+    link_to_function("[#{title}]", "show_view('#{page_name}')");
+  end
+
+
+  def link_to(name, location)
+    location = "/mmtrix/#{location}" unless /:\/\// =~ location
+    "<a href=\"#{location}\">#{name}</a>"
+  end
+
+  def link_to_if(predicate, text, location="")
+    if predicate
+      link_to(text, location)
+    else
+      text
+    end
+  end
+
+  def link_to_unless_current(text, hash)
+    unless params[hash.keys[0].to_s]
+      link_to(text,"?#{hash.keys[0]}=#{hash.values[0]}")
+    else
+      text
+    end
+  end
+
+  def cycle(even, odd)
+    @cycle ||= 'a'
+    if @cycle == 'a'
+      @cycle = 'b'
+      even
+    else
+      @cycle = 'a'
+      odd
+    end
+  end
+
+  def link_to_function(title, javascript)
+    "<a href=\"#\" onclick=\"#{javascript}; return false;\">#{title}</a>"
+  end
+
+  def mime_type_from_extension(extension)
+    extension = extension[/[^.]*$/].dncase
+    case extension
+      when 'png'; 'image/png'
+      when 'gif'; 'image/gif'
+      when 'jpg'; 'image/jpg'
+      when 'css'; 'text/css'
+      when 'js'; 'text/javascript'
+    else 'text/plain'
+    end
+  end
+  def to_ms(number)
+   (number*1000).round
+  end
+  def to_percentage(value)
+   (value * 100).round if value
+  end
+  def with_delimiter(val)
+    return '0' if val.nil?
+    parts = val.to_s.split('.')
+    parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")
+    parts.join '.'
+  end
+
+  SORT_REPLACEMENTS = {
+      "Total" => :total_time,
+      "Self" => :self_time,
+      "Child" => :children_time,
+      "Wait" => :wait_time
+  }
+
+  def profile_table(sample, options)
+    out = StringIO.new
+    printer = RubyProf::GraphHtmlPrinter.new(sample.profile)
+    printer.print(out, options)
+    out = out.string[/<body>(.*)<\/body>/im, 0].gsub('<table>', '<table class=profile>')
+    SORT_REPLACEMENTS.each do |text, param|
+      replacement = (options[:sort_method] == param) ?
+          "<th> #{text}&nbsp;&darr;</th>" :
+          "<th>#{link_to text, "show_sample_summary?id=#{sample.sample_id}&sort=#{param}"}</th>"
+
+      out.gsub!(/<th> +#{text}<\/th>/, replacement)
+    end
+    out
+  end
+end

data/ui/helpers/google_pie_chart.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+require 'cgi'
+
+# A wrapper around the google charts service.
+class GooglePieChart
+  attr_accessor :width, :height, :color
+
+  def initialize
+    # an array of [label, value]
+    @data = []
+    self.width = 300
+    self.height = 200
+  end
+
+  def add_data_point(label, value)
+    @data << [label, value]
+    @max = (@max.nil? || @max < value ? value : @max)
+  end
+
+  # render the chart to html by creating an image object and
+  # placing the correct URL to the google charts api
+  def render
+    labels = []
+    values = []
+    @data.each do |label, value|
+      labels << CGI::escape(label)
+      values << (value > 0 ? value * 100 / @max : value).round.to_s
+    end
+    params = {:cht => 'p', :chs => "#{width}x#{height}", :chd => "t:#{values.join(',')}", :chl => labels.join('|') }
+    params['chco'] = color if color
+
+    url = "http://chart.apis.google.com/chart?#{to_query(params)}"
+
+    alt_msg = "This pie chart is generated by Google Charts. You must be connected to the Internet to view this chart."
+    html = "<img id=\"pie_chart_image\" src=\"#{url}\" alt=\"#{alt_msg}\"/>"
+    return html
+  end
+
+private
+  # Hash#to_query is not present in all supported rails platforms, so implement
+  # its equivalent here.
+  def to_query(params)
+    p = []
+    params.each do |k,v|
+      p << "#{k}=#{v}"
+    end
+
+    p.join "&"
+  end
+end

data/ui/views/layouts/mmtrix_default.rhtml

@@ -0,0 +1,48 @@
+<html xmlns="http://www.w3.org/1999/xhtml"
+    xml:lang="en" lang="en">
+<head>
+<script type="text/javascript" src="/mmtrix/file/javascript/jquery-1.4.2.js"></script>
+<meta charset="utf-8" />
+<title>Mmtrix Developer Mode</title>
+	<link href="/mmtrix/file/stylesheets/style.css"
+				media="screen" rel="stylesheet" type="text/css" />
+</head>
+<body>
+	<div id="header">
+		<img width="100%" height="4" src="/mmtrix/file/images/blue_bar.gif" alt="spacer"/>
+		<table width="100%" height="60">
+			<tr>
+				<td valign="middle">
+					<a href='/mmtrix'><img src="/mmtrix/file/images/mmtrix_rpm_desktop.gif" hspace="10" alt="Mmtrix"/></a>
+				</td>
+				<td class="top_nav" valign="bottom">
+					<ul id="navlist">
+						<li>&raquo; <a href='/mmtrix'>Home</a></li>
+					</ul>
+				</td>
+			</tr>
+		</table>
+		<div id="page_nav">
+			<table width="100%" height="100%" background="/mmtrix/file/images/gray_bar.gif">
+				<tr valign="middle">
+					<td>
+						<span class="application_title">Developer Mode</span>
+					</td>
+					<td class="title_bar_right">
+						Monitor your Rails Application in production. <%=link_to 'Learn more.', 'http://www.mmtrix.com' %>
+					</td>
+				</tr>
+			</table>
+		</div>
+	</div>
+	<div id='content'>
+		<%= yield %>
+	</div>
+	<div id='footer'>
+		<img width="100%" height="4" src="/mmtrix/file/images/blue_bar.gif" alt="spacer"/>
+		<p>
+		<a href="/mmtrix">Home</a> | <a href="&#109;&#97;&#105;&#108;&#116;&#111;:&#x73;&#x75;&#x70;&#112;&#111;&#x72;&#116;&#x40;&#x6E;&#x65;&#119;&#114;&#x65;&#x6C;&#105;&#x63;&#x2E;&#99;&#x6F;&#109;?subject=&#70;&#101;&#x65;&#x64;&#x62;&#x61;&#x63;&#107;" title="">&#x46;&#x65;&#101;&#x64;&#98;&#97;&#x63;&#x6B;</a><br />
+		Monitor your Rails Application in Production. <a href="http://www.mmtrix.com">Learn more. &raquo;</a><br />
+		&copy; 2008 - <%= Time.now.strftime('%Y') %> Mmtrix. All rights reserved.</p>
+	</div>
+</body>