class ActionDispatch::RequestId
typically end up being part of log files from multiple pieces of the stack.
The unique request id can be used to trace a request end-to-end and would
chars and alphanumeric and dashes only.
header is accepted from the outside world, we sanitize it to a max of 255
the web server, or, if this header is not available, a random uuid. If the
request, which would typically be generated by a firewall, load balancer, or
The unique request id is either based on the ‘X-Request-Id` header in the
via the `X-Request-Id` header.
or the alias ActionDispatch::Request#uuid) and sends the same id to the client
variable (which is then accessible through ActionDispatch::Request#request_id
Makes a unique request id available to the `action_dispatch.request_id` env
# Action Dispatch RequestId
def call(env)
def call(env) req = ActionDispatch::Request.new env req.request_id = make_request_id(req.get_header(@env_header)) @app.call(env).tap { |_status, headers, _body| headers[@header] = req.request_id } end
def initialize(app, header:)
def initialize(app, header:) @app = app @header = header @env_header = "HTTP_#{header.upcase.tr("-", "_")}" end
def internal_request_id
def internal_request_id SecureRandom.uuid end
def make_request_id(request_id)
def make_request_id(request_id) if request_id.presence request_id.gsub(/[^\w\-@]/, "").first(255) else internal_request_id end end