nginx-proxy / nginx-proxy/nginx-proxy

Add an UUID to every incoming request

Open
#891 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
19.9k
Forks
3k
Avg merge
2d 11h
Merged PRs (30d)
1

Description

Given the fact that nginx-proxy will usually be used in a distributed environnement, I think it would make sense to add an UUID to each incoming request to help trace them.

proxy_set_header X-Request-UUID $request_id; could be added to nginx-tmpl and log_format changed to

log_format vhost '$host $remote_addr - $remote_user [$time_local] '
                 '"$request" $status $body_bytes_sent '
                 '"$http_referer" "$http_user_agent" "$request_id"';

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting nginx-tmpl and the existing log_format configuration. Add the request UUID header and include the request ID in the access log as described; done means every incoming request carries the UUID and the generated logs record it.

Written by the indexing model from the issue text.

Assessment

Tech stack
nginx
Domain
networking
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.