Rubyメソッドをスパイする方法!TracePointで実行をトレースしよう

Rubyには、TracePointクラスを使ってアクセスできる組み込みのトレーシングシステムが備わっています。このシステムを利用すると、メソッド呼び出し、新しいスレッドの開始、例外の発生などをトレースできます。

なぜこれを使いたくなるのでしょうか?

たとえば、特定のメソッドの実行過程を追跡したい場合に非常に便利です。その処理の中で他にどのメソッドが呼ばれているのか、どんな戻り値が返されているのかを、目で確認できるようになります。

それでは、いくつか具体例を見ていきましょう!

メソッド呼び出しをトレースする

多くの場合、TracePointでトレースしたいのはアプリケーション側のコードであり、組み込みメソッド(putsやsizeなど)ではないはずです。

そんなときはcallイベントを使います。

例:

def the_method; other_method; end
def other_method; end

def start_trace
  trace =
  TracePoint.new(:call) { |tp| p [tp.path, tp.lineno, tp.event, tp.method_id] }

  trace.enable
  yield
  trace.disable
end

start_trace { the_method }

このコードは、ファイルパス・行番号・イベント名・メソッド名を出力します。

["test.rb", 1, :call, :the_method]
["test.rb", 2, :call, :other_method]

イベントを何も指定しなかった場合、Rubyはすべてのイベントに対してブロックを呼び出すため、出力が膨大になってしまいます。目的の情報に素早くたどり着くためにも、特定のイベントに絞ってトレースすることをおすすめします🙂

以下はTracePointの主なイベント一覧です。

TracePoint + Graphvizでコールグラフを可視化

特にフレームワークのコードでは、1つのメソッドが3つ以上のメソッドを呼び出すのは珍しくありません。そのため、TracePointのテキスト出力だけでは全体像を把握しづらいことがあります。

そこで私は、次のような視覚的なコールグラフを作成できるgemを作りました。

require 'visual_call_graph'

VisualCallGraph.trace { "Your method call here..." }

これを実行すると、結果がcall_graph.pngファイルとして生成されます。

なお、これは静的解析ではなく、実際にメソッドを呼び出して計測している点に注意してください。

ファイルパスを表示する

「これらのメソッドがどこで定義されているのか知りたい」と思いませんか?

ご安心ください!各メソッド呼び出しのファイルパスを表示できるオプションも用意しています。

VisualCallGraph.trace(show_path: true) { Foo.aaa }

実行結果:

巨大なコールグラフを見てみたい場合は、Railsのメソッドをトレースしてみてください😉

戻り値を取得する

冒頭で触れたとおり、戻り値も取得できます。

その場合はreturnイベントをトレースし、return_valueメソッドを使用します。

例:

def the_method; "A" * 10; end

trace = TracePoint.new(:return) { |tp| puts "Return value for #{tp.method_id} is #{tp.return_value}." }

trace.enable
the_method
trace.disable

このコードは次のように出力します。

Return value for the_method is AAAAAAAAAA.

イベントは「先」に発生する

Redditにこんな質問が投稿されました。「次のコードでfooメソッドを呼び出したとき、"bar"という文字列が出力されないようにするにはどうすればよいか?」というものです。

class Thing
  def foo
    puts "foo"
    bar
  end

  def bar
    puts "bar"
  end
end

# your code here

t = Thing.new
t.foo

これを実現する方法はいくつもあります。モジュールをprependする、$stdoutをリダイレクトする、barメソッドを再定義するなどです。

もし自分ならこうするというアイデアが浮かんだら、ぜひコメントで教えてください!

しかし、その中でも特に興味深い回答がありました。TracePointクラスを使ったものです。

そのコードがこちら:

TracePoint.trace(:call) { |tp| exit if tp.method_id == :bar }

このコードは、barメソッドが呼ばれた時点でexitを実行し、プログラムを終了させることで文字列の出力を防ぎます。

実務のコードで使いたいテクニックではありませんが、TracePointについて重要な事実を1つ証明しています。それは、「イベントは実際に起きる前に発火する」ということです。

この仕組みを使って何らかのツールを作る予定があるなら、ぜひ覚えておきたい挙動ですね🙂

まとめ

この記事では、メソッド呼び出しや新規スレッドなどのイベントをトレースできるTracePointクラスについて学びました。デバッグツールとしてだけでなく、コードの探索や理解にも役立つ強力な機能です。

この記事が役に立ったら、ぜひシェアして、更多人に届けてください🙂