Ruby探針的基本實現原理

李哲 — MAY 13, 2015

語言本身

Ruby語言支持語法級別的系統，框架，甚至語言本身的方法復寫，一般叫做元編程（meta programming）， 此基礎之上還有一些術語為mixin，方法的動態定義，運行時類改寫等等，這些技術和機制可以讓語言本身就能實 現其他語言需要字節碼才能實現的功能，例如探針需要hook HttpRequest中的request方法，就可以通過下面的方式實現：

class HttpRequest
  def request_new
    puts 'before request'
    result = request_old
    puts 'after request'
    result
  end
  alias_method :request_old, :request
  alias_method :request, :request_new
end

這里只是展示其中一種最簡單的方法，還有很多其他方法，比如我們想完全放棄原有的方法的話，那就可以直接覆蓋掉這個方法了。

框架

某些框架如Rails提供pub-sub機制，這種情況下探針只需要訂閱特定類型的消息，然后進行數據再加工就可以了。對于Rails，這個比較簡單：

module ActionController
  class PageRequest
    def call(name, started, finished, unique_id, payload)
      Rails.logger.debug [name, started, finished, unique_id, payload].join(' ')
    end
  end
end
ActiveSupport::Notifications.subscribe('process_action.action_controller', ActionController::PageRequest.new)
# 每次訪問就能夠訂閱到‘process_action.action_controller’的消息：
#
# process_action.action_controller 2012-04-13 01:08:35 +0300 2012-04-13 01:08:35 +0300 af358ed7fab884532ec7 {
#   controller: "Devise::SessionsController",
#   action: "new",
#   params: {"action"=>"new", "controller"=>"devise/sessions"},
#   format: :html,
#   method: "GET",
#   path: "/login/sign_in",
#   status: 200,
#   view_runtime: 279.3080806732178,
#   db_runtime: 40.053
# }

這樣我們就能拿到這個request的數據了，訂閱消息類型還請自己查閱相關框架的文檔。

RACK

Rack絕對是個好東西，它把幾乎所有的web框架和server溝通的接口定義好了，而且是如此的簡潔，就是一個call方法。 一個最簡單的Rack應用如下：

# configu.ru
class App
  def call
    [200, {"Content-Type" => "text/html"}, ["hello world"]]
  end
end
run app
# rackup

只需要這個call方法就搞定了，而多層的rack middleware也只是嵌套著調用call方法，所有要hook的話，這里就夠了， 不過因為這里基本就是根了，需要注意抓取的數據量及堆棧信息，太長的話會影響性能的。

數據庫

數據庫層基本都是對orm框架的hook，在每個查詢的結果輸出中都會有執行的時間信息，超過閥值則調用數據庫本身的查詢 語句優化工具，并保存輸出結果。至于hook的方法就是【1】中或者采用【2】中的方法，如果框架支持的話。

外部服務

外部服務就是對訪問外部http請求的http_client類似的庫進行hook，也就是按照【1】中的方法，對發起request的方法進行hook。

后臺任務

后臺任務機制同上面幾項，只不過是在非http server的進程中運行，數據抓取的機制一樣，但分類不同， 需要探針在運行過程中，判斷數據抓取的對象狀態，即web事務中還是非web事務中，非web事務都統一存 儲到后臺任務的數據容器中。

Thread Profiler

Thread Profiler就是一個加強版的事務采集器，可以設定采樣周期和采樣頻率，將周期內的事務請求進行數據的聚合處理， 然后統計出在這個周期內的堆棧調用占比信息，然后可以根據此信息找出時間占比或者調用次數最多的方法，然后有針對性的 進行優化。

總結

以上所述，還只是一些最根本的原理性知識，細節的點還有很多，比如如何進行數據的本地存儲和處理，以及線程間的數據沖突處理， 還有基于fork的多進程server的進程間的數據傳輸，在以后的文章中，會針對每一項都做出詳細的解釋，還請大家持續關注。

本文作者系OneAPM工程師李哲 ，想閱讀更多好的技術文章，請訪問OneAPM官方技術博客。