Ruby 探針的基本實現原理

OneAPM藍海訊通發表於2019-02-16

語言本身

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

Rubyclass 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，這個比較簡單：

rubymodule 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應用如下：

ruby# 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官方技術部落格。

相關文章