edge badge

Makes a unique request id available to the action_dispatch.request_id env variable (which is then accessible through ActionDispatch::Request#uuid or the alias ActionDispatch::Request#request_id) and sends the same id to the client via the X-Request-Id header.

The unique request id is either based on the X-Request-Id header in the request, which would typically be generated by a firewall, load balancer, or the web server, or, if this header is not available, a random uuid. If the header is accepted from the outside world, we sanitize it to a max of 255 chars and alphanumeric and dashes only.

The unique request id can be used to trace a request end-to-end and would typically end up being part of log files from multiple pieces of the stack.

Methods
C
N
Constants
X_REQUEST_ID = "X-Request-Id".freeze
 
ACTION_DISPATCH_REQUEST_ID = "action_dispatch.request_id".freeze
 
HTTP_X_REQUEST_ID = "HTTP_X_REQUEST_ID".freeze
 
Class Public methods
new(app)
# File actionpack/lib/action_dispatch/middleware/request_id.rb, line 19
def initialize(app)
  @app = app
end
Instance Public methods
call(env)
# File actionpack/lib/action_dispatch/middleware/request_id.rb, line 23
def call(env)
  env[ACTION_DISPATCH_REQUEST_ID] = external_request_id(env) || internal_request_id
  @app.call(env).tap { |_status, headers, _body| headers[X_REQUEST_ID] = env[ACTION_DISPATCH_REQUEST_ID] }
end