common correlationID/requestID header in all web requests for image pulls

[masudkhan1]

What is the version of your Overlaybd

No response

What would you like to be added?

Add a correlationID/requestID header to all web requests to the container registry. An image pull operation consists of a series of web requests to a container registry and all of those requests that are part of the same image pull operation should have the same correlationID/requestID.

Why is this needed for Overlaybd?

Based on the OCI spec, image pull requests consist of a series of API requests to a container registry, followed by a series of API requests to blob storage objects. For example, an image pull may consist of:

• HEAD request to registry to check if the image exists
• token request to registry, including auth header, to authenticate
• GET request to registry to fetch manifest
• GET requests to registry to fetch all blobs

To help debug container registry bugs/issues it would be very helpful to have a correlationID added as a header. For a single image pull, the correlationID should be the same across all web requests so that on the server side, we can grep logs for only that correlationID, and be able to find logs for all requests & responses. This would help debug common issues that are triggered by one API request but that don't cause problems until a later one (e.g. auth request returned 200 response with a token, but using that token in a subsequent manifest request results in a 401 unauthorized).

Are you willing to submit PRs to contribute to this feature?

• Yes, I am willing to implement it.