How to create a correlation id using either an id from the message or x-appgw-trace-id

Question

In our setting we use correlation ID's for everything.

My vision of this is the following:

1. Application Gateway checks if the request (from the consumer) already contains a header called "correlation-id"
2. If this header exists, forward this header to the backend under the header "correlation-id" and include it in the response
3. If this header does not exist, create it ("correlation-id") using the  value generated by the AG in the field x-appgw-trace-id

How would we be able to do this?

Answer 1

@Niels Beukenkamp

Thank you for reaching out.

Based on your points mentioned above.

If this header does not exist, create it ("correlation-id") using the  value generated by the AG in the field

Currently assigning the x-appgw-trace-id value to a custom-header is not supported in Application Gateway. If you wish to add this as a feature, it will help if you can create a feedback item for this request on our feedback portal.

Alternatively, I realized you question was tagged with Azure API Management service. If you are using Azure APIM service in your set-up. You can use APIM policies to add a correlation id to your request as described in your points above . You can refer to this sample described here.

Hope this helps! Please let me know if you have any additional questions. Thank you!

---

​​Please "Accept the answer" if the information helped you. This will help us and others in the community as well.