Logging in Rails with a per-request ID

Question

I'm looking for a quick and easy way to generate a unique per-request ID in rails that I can then use for logging across a particular request.

Any solution should ideally not make too much use of the default logging code, as I'm running the application under both jruby and ruby.

Would that be available inside models and observers as well as controllers? — cbz, Aug 01 '11 at 11:32
I'm afraid not, you'd have to propagate it yourself, probably similar to http://www.zorched.net/2007/05/29/making-session-data-available-to-models-in-ruby-on-rails/ — Mladen Jablanović, Aug 01 '11 at 12:32

score 6 · Answer 1 · answered Feb 22 '13 at 03:13

Backupify produced a great article about this: http://blog.backupify.com/2012/06/27/contextual-logging-with-log4r-and-graylog/

We wanted the request_id (that is generated by rails and available at request.uuid to be present on all messages throughout the request. In order to get it into the rack logging (the list of parameters and the timing among others), we added it to the MDC in a rack middleware.

application.rb:

config.middleware.insert_after "ActionDispatch::RequestId", "RequestIdContext"

app/controllers/request_id_context.rb: (had trouble finding it in lib for some reason)

class RequestIdContext
  def initialize(app)
    @app = app
  end

  def call(env)
    Log4r::MDC.get_context.keys.each {|k| Log4r::MDC.remove(k) }
    Log4r::MDC.put("pid", Process.pid)
    Log4r::MDC.put("request_id", env["action_dispatch.request_id"])
    @app.call(env)
  end
end

If you push jobs onto delay job/resque, put the request_id into the queue. and in your worker pull it off and set into the MDC. Then you can trace the requests the whole way through

score 4 · Answer 2 · answered Mar 14 '16 at 11:27

4

It looks like lograge (gem) automatically puts request.uuid in your logs.

They have this pattern: bfb1bf03-8e12-456e-80f9-85afaf246c7f

answered Mar 14 '16 at 11:27

Benjamin Crouzier

40,265
44
171
236

score 2 · Answer 3 · answered Mar 06 '20 at 22:08

2

This is now a feature of rails:

class WidgetsController < ApplicationController
  def get
    puts request.request_id
  end
end

answered Mar 06 '20 at 22:08

davetron5000

24,123
11
70
98

score 0 · Answer 4 · answered Oct 18 '11 at 09:23

0

Maybe the NDC feature of log4r is usefull to you.

answered Oct 18 '11 at 09:23

rsp

23,135
6
55
69

Logging in Rails with a per-request ID

4 Answers4

Linked