Parent

Class Index [+]

Quicksearch

ActionDispatch::RequestId

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

The unique request id is either based off 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.

Public Class Methods

new(app) click to toggle source
    # File lib/action_dispatch/middleware/request_id.rb, line 16
16:     def initialize(app)
17:       @app = app
18:     end

Public Instance Methods

call(env) click to toggle source
    # File lib/action_dispatch/middleware/request_id.rb, line 20
20:     def call(env)
21:       env["action_dispatch.request_id"] = external_request_id(env) || internal_request_id
22:       status, headers, body = @app.call(env)
23: 
24:       headers["X-Request-Id"] = env["action_dispatch.request_id"]
25:       [ status, headers, body ]
26:     end

Private Instance Methods

external_request_id(env) click to toggle source
    # File lib/action_dispatch/middleware/request_id.rb, line 29
29:       def external_request_id(env)
30:         if request_id = env["HTTP_X_REQUEST_ID"].presence
31:           request_id.gsub(/[^\w\-]/, "").first(255)
32:         end
33:       end
internal_request_id() click to toggle source
    # File lib/action_dispatch/middleware/request_id.rb, line 35
35:       def internal_request_id
36:         SecureRandom.hex(16)
37:       end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.