Ruby中的Profiling工具

看看如何調(diào)試Ruby的性能問(wèn)題

李哲 — APRIL 08, 2015

Ruby內(nèi)置的profiler

內(nèi)置的profiler實(shí)現(xiàn)的很簡(jiǎn)單，在ruby2.2中只有150行代碼，大家可以看看它的實(shí)現(xiàn)profile.rb 。內(nèi)置的profiler使用起來(lái)非常的方便，只需要加上-rprofile參數(shù)即可。例如：

執(zhí)行：

ruby -rprofile test.rb 
輸出結(jié)果為：

 %   cumulative   self              self     totaltime   seconds   seconds    calls  ms/call  ms/call  name24.24     0.16      0.16    10001     0.02     0.06  Object#m218.18     0.28      0.12        2    60.00   330.00  Integer#times18.18     0.40      0.12    10001     0.01     0.06  Object#m115.15     0.50      0.10    10001     0.01     0.01  Class#new10.61     0.57      0.07    10000     0.01     0.01  P1.new 6.06     0.61      0.04    20000     0.00     0.00  Fixnum#to_s 4.55     0.64      0.03    10000     0.00     0.00  Struct#initialize 3.03     0.66      0.02    10000     0.00     0.00  P2#initialize 0.00     0.66      0.00        1     0.00     0.00  TracePoint#enable 0.00     0.66      0.00        1     0.00     0.00  Class#initialize 0.00     0.66      0.00        1     0.00     0.00  nil# 0.00     0.66      0.00        1     0.00     0.00  Struct.new 0.00     0.66      0.00        7     0.00     0.00  Module#method_added 0.00     0.66      0.00        3     0.00     0.00  BasicObject#singleton_method_added 0.00     0.66      0.00        2     0.00     0.00  Class#inherited 0.00     0.66      0.00        2     0.00     0.00  IO#set_encoding 0.00     0.66      0.00        1     0.00     0.00  TracePoint#disable 0.00     0.66      0.00        1     0.00   660.00  #toplevel

通過(guò)打印出的結(jié)果能夠很明顯的看出耗時(shí)的方法。內(nèi)置的profiler很簡(jiǎn)單，只能打印出這樣的結(jié)果，沒(méi)有 其他輸出格式的選項(xiàng)，下面介紹的其他幾種都有豐富的格式輸出。

ruby-prof

repo: https://github.com/ruby-prof/ruby-prof

ruby-prof 具有C擴(kuò)展，所以它能運(yùn)行的更快，同時(shí)它支持豐富的輸出格式，方便我們?nèi)ゲ檎倚阅芷款i。 ruby-prof支持輸出GraphViz 支持的dot格式，兩者的安裝方法如下：

gem install ruby-prof

ubuntu | sudo apt-get install graphviz 
Mac | brew install graphviz

執(zhí)行命令很簡(jiǎn)單，如下：

ruby-prof --mode=wall --printer=dot --file=output.dot test.rb 25 
此命令的詳細(xì)使用方法請(qǐng)參考幫助信息ruby-prof --help。

上面命令的執(zhí)行結(jié)果會(huì)輸出一個(gè)graphviz的dot文件，graphviz提供一個(gè)格式轉(zhuǎn)換命令，可以將此文件轉(zhuǎn)換為一個(gè)pdf文件以方便查看，如下：

dot -T pdf -o output.pdf output.dot

這樣就可以打開(kāi)output.pdf查看程序內(nèi)的方法調(diào)用占比了。 

perftools.rb

repo: https://github.com/tmm1/perftools.rb

perftools.rb是google-perftools的ruby版本，不過(guò)它只支持ruby2.1以下版本，2.1及以上 版本就需要用到下面的stackprof了，這兩個(gè)工具都是一個(gè)人寫(xiě)的。鑒于此，我們略過(guò)perftools.rb， 作者實(shí)現(xiàn)stackprof，就是為了替代perftools.rb。如果有需求的話(huà)，就請(qǐng)參考其github主頁(yè)。

stackprof

repo: https://github.com/tmm1/stackprof

stackprof只支持Ruby2.1+，不過(guò)現(xiàn)在ruby的版本發(fā)布很快，每一個(gè)版本都能帶來(lái)一些新東西，2.1 應(yīng)該很快就能成為很基礎(chǔ)的版本，我們就在這個(gè)版本上來(lái)做一些測(cè)試。

安裝：

gem install stackprof

這次我們直接在代碼中使用stackprof的方法：

require 'stackprof'def m1  5_000_000.times{ 1+2+3+4+5 }enddef m2  1_000_000.times{ 1+2+3+4+5 }endStackProf.run(mode: :cpu, out: 'tmp/stackprof.dump') do  m1  m2end

我們執(zhí)行這個(gè)ruby程序，ruby test.rb，會(huì)在當(dāng)前目錄的tmp目錄中產(chǎn)生一個(gè)文件stackprof.dump, 然后來(lái)分析以下這個(gè)文件，stackprof命令本身可以解析這個(gè)文件，執(zhí)行下面的命令：

stackprof tmp/stackprof.dump --text

則會(huì)產(chǎn)生下面的結(jié)果，結(jié)果應(yīng)該是很清晰的，很明顯在代碼中m1方法要占有絕大部分的運(yùn)行時(shí)間。

  Mode: cpu(1000)   Samples: 75 (0.00% miss rate)   GC: 0 (0.00%)=====================================================================     TOTAL    (pct)     SAMPLES    (pct)     FRAME        62  (82.7%)          62  (82.7%)     block in Object#m1        13  (17.3%)          13  (17.3%)     block in Object#m2        75 (100.0%)           0   (0.0%)     <main>        75 (100.0%)           0   (0.0%)     block in <main>        75 (100.0%)           0   (0.0%)     <main>        62  (82.7%)           0   (0.0%)     Object#m1        13  (17.3%)           0   (0.0%)     Object#m2

其他更加豐富的輸出方式和分析方式，就請(qǐng)參考stackprof的github主頁(yè)，講解的很全面。

如果你希望在web前端中展示相關(guān)信息，就請(qǐng)看看stackprof-webnav這個(gè)gem，它提供了比較全面的 展示，操作等等，適合在一些web應(yīng)用中使用，github地址：stackprof-webnav

rack-mini-profiler

repo: https://github.com/MiniProfiler/rack-mini-profiler

rack-mini-profiler專(zhuān)門(mén)應(yīng)用于基于rack的web應(yīng)用的性能調(diào)優(yōu)，在rails中的使用方法如下：

首先將gem添加到gemfile中：

gem 'rack-mini-profiler'

執(zhí)行：

bundle install

然后重啟你的服務(wù)器，訪(fǎng)問(wèn)任意的URl，在頁(yè)面上的左上角會(huì)看到響應(yīng)時(shí)間的毫秒數(shù)。如下圖所示： 

點(diǎn)擊query time(ms)列中的1 sql則可以查看到執(zhí)行的sql語(yǔ)句及耗時(shí)： 

本文作者系OneAPM工程師李哲 ，想閱讀更多好的技術(shù)文章，請(qǐng)?jiān)L問(wèn)OneAPM官方技術(shù)博客。