ログが読めない混乱にならないようにする

より頻繁にログを記録し、より複雑なものをログに記録すると、それらのタグがメッセージをより明確にする領域に自然に気付くでしょう。 しかし、タグ付きロギングが特に役立つと思った場所がいくつかあります。 通常、すぐにタグを付けます。

他のAPIへのリクエストをログに記録できます：

logger.tagged("GitHub API") do
  uri = URI("https://api.github.com/repos/rails/rails/tags")

  logger.info { "Fetching #{uri}" }
  tags = JSON.parse(Net::HTTP.get(uri))
  logger.info { "First tag: #{tags.first["name"]}" }
end

[GitHub API] Fetching https://api.github.com/repos/rails/rails/tags
[GitHub API] First tag: v4.2.4.rc1

そうすれば、アプリがそのAPIといつどのように通信しているかを簡単に確認できます。

（これは、ファラデーミドルウェアで、またはゲートウェイを介してのみサーバーと通信する場合に特に効果的です。）

バックグラウンドジョブは、タグ付きロギングでもうまく機能します：

require "active_support/tagged_logging"

Resque.logger = ActiveSupport::TaggedLogging.new(Resque.logger)

module LoggedJob
  def around_perform_log_job(*args)
    logger.tagged(name) do
      logger.info { "Performing #{name} with #{args.inspect}" }
      yield
    end
  end
end

class MyJob
  extend LoggedJob

  def self.perform(*args)
    ...
  end
end

これで、LoggedJobを拡張するジョブには、すべてのログメッセージにジョブのクラス名のタグが付けられます。

ログインしているユーザーがいる場合は、そのユーザーIDでメッセージにタグを付けることができます：

logger.tagged(current_user_id ? "user-#{current_user_id}" : "user-anonymous") do
  logger.debug "Finding people..."
  @people = Person.all
  logger.debug "Found #{@people.length} people!"
end

[user-123] Finding people...
[user-123]   Person Load (0.3ms)  SELECT "people".* FROM "people"
[user-123] Found 0 people!

最後に、config/environments/production.rbに行を追加した場合 （またはdevelopment.rb ）、Railsにメッセージに自動的にタグを付けることができます：

config.log_tags = [ :subdomain, :uuid ]

log_tags すべてのRailsログエントリの先頭に表示するタグを一覧表示します。各シンボルはActionDispatch::Requestのメソッドを参照しているため、:uuid request.uuidを意味します 。

requestを受け取るProcを渡すこともできます オブジェクト：

config.log_tags = [ :subdomain, :uuid, lambda { |request| request.headers["User-Agent"] } ]

しかし、私はそれほど頻繁には見ません。

これらのデフォルトのタグは素晴らしいです：uuid 1つのリクエストで発生するすべてのログエントリを結び付けることができます。サーバーでセッションを維持している場合は、セッションIDも役立ちます。 これらのタグと十分なメッセージがあれば、アプリ内の非常に複雑なパスをたどることができます。 そして通常、それは厄介なバグがどのように起こったかを理解するために必要なことです。

アプリでRailsロガーをどのくらい使用していますか？タグ付きロギングを試しましたか？まだの場合は、その場所を探してみてください。 ユーザーが実行したアクションにタグを付けることは良いスタートです。 次回、クレイジーなマルチステップのバグをデバッグする必要があるときに役立ちます。

ロギングやその他のデバッグ手法について詳しく知りたい場合は、アプリの作成時に発生するエラーを見つけて修正するために、「レールの練習」の章全体を取り上げました。 ここで最初の章を無料で入手してください。