Rubyで例外が発生したときにローカル変数とインスタンス変数をログに記録する

簡単に再現できないバグがあったことはありますか？それは、人々があなたのアプリをしばらく使用したときにのみ起こるようです。そして、エラーメッセージとバックトレースは驚くほど役に立ちません。

例外が発生する直前のアプリの状態のスナップショットを撮ることができれば、このような場合に非常に便利です。たとえば、すべてのローカル変数とその値のリストを作成できる場合。ええと、できます-そしてそれはそれほど難しいことではありません！

この投稿では、例外時にローカルをキャプチャする方法を紹介します。しかし、最初に、私はあなたに警告する必要があります。 これらの手法はいずれも本番環境では使用しないでください。 ステージング、プレプロデュース、開発などで使用できます。本番環境では使用できません。私たちが使用する宝石は、かなり重い内省魔法に依存しており、せいぜいアプリの速度を低下させます。最悪の場合...誰が知っていますか？

binding_of_callerの紹介

binding_of_caller gemを使用すると、現在のスタックの任意のレベルのバインディングにアクセスできます。すっごく.....それは正確にはどういう意味ですか？

「スタック」は、現在「進行中」のメソッドのリストにすぎません。 callerを使用できます 現在のスタックを調べるメソッド。簡単な例を次に示します。

def a
  puts caller.inspect # ["caller.rb:20:in `<main>'"]
  b()
end

def b
  puts caller.inspect # ["caller.rb:4:in `a'", "caller.rb:20:in `<main>'"]
  c()
end

def c
  puts caller.inspect # ["caller.rb:11:in `b'", "caller.rb:4:in `a'", "caller.rb:20:in `<main>'"]
end

a()

バインディングは、現在の実行コンテキストのスナップショットです。以下の例では、メソッドのバインディングをキャプチャし、それを使用してメソッドのローカル変数にアクセスします。

def get_binding
  a = "marco"
  b = "polo"
  return binding
end

my_binding = get_binding

puts my_binding.local_variable_get(:a) # "marco"
puts my_binding.local_variable_get(:b) # "polo"

binding_of_caller gemを使用すると、現在の実行スタックの任意のレベルのバインディングにアクセスできます。たとえば、これを使用してcを許可できます。 aへのメソッドアクセス メソッドのローカル変数。

require "rubygems"
require "binding_of_caller"

def a
  fruit = "orange"
  b()
end

def b
  fruit = "apple"
  c()
end

def c
  fruit = "pear"

  # Get the binding "two levels up" and ask it for its local variable "fruit"
  puts binding.of_caller(2).local_variable_get(:fruit) 
end

a() # prints "orange"

この時点で、おそらく2つの相反する感情を感じています。これは本当にクールなので、興奮。そして嫌悪感。これは、DHHと言うよりも早く依存関係の醜い混乱に退化する可能性があるためです。

require "rubygems"
require "binding_of_caller"

module LogLocalsOnRaise
  def raise(*args)
    b = binding.of_caller(1)
    b.eval("local_variables").each do |k|
      puts "Local variable #{ k }: #{ b.local_variable_get(k) }"
    end
    super
  end
end

class Object
  include LogLocalsOnRaise
end

def buggy
  s = "hello world"
  raise RuntimeError
end

buggy()

# Gemfile

group :development, :staging do
  # Including this gem enables local variable capture via Honeybadger
  gem "binding_of_caller"
  ...
end