Enhance MarshalRequest/InvokeFeatures to setup the IHttpRequestIdentifierFeature

[brendonparker]

Describe the feature

Enhance the Lambda to AspNetCore handoff to include either (or both) the AwsRequestId from the ILambdaContext and the TraceId from the LambdaContext.

Use Case

This will help log correlation with things like AWS X-Ray, or other AWS Logs that are capturing the RequestId.

Proposed Solution

1. Enhance Amazon.Lambda.AspNetCoreServer.Internal.InvokeFeatures to implement Microsoft.AspNetCore.Http.Features.IHttpRequestIdentifierFeature.
2. Enhance the various implementations of MarshallRequest to setup the IHttpRequestIdentifierFeature, specifying using the ILambdaContext.AwsRequestId.

Other Information

See linked discussion for the path I took to get here. I'm not certain which makes more sense to use, the AwsRequestId or the TraceId. May depend on if you are using AWS X-Ray. Perhaps configurable?

This may be considered a breaking change, as it will no longer use the dotnet-generated RequestId. However, I feel using the AwsRequestId is more correct.

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

AWS .NET SDK and/or Package version used

Amazon.Lambda.AspNetCoreServer.Hosting 1.0.0

Targeted .NET Platform

.NET Core 3.1, .NET 6

Operating System and version

Windows 10, OSX Mojave, Ubuntu, AmazonLinux

[brendonparker]

Here is the discussion: #1147

[normj]

Thanks for the great feature request. I like the idea of having the HttpContext.TraceIdentifier match the X-Ray trace ID. I think we should aim to do that.

As far as customization goes in the older style of writing ASP.NET Core Lambda functions you used to be able to override methods from a base class to customize the marshalling between API Gateway and ASP.NET Core. That ability got lost in the new approach using the AddAWSLambdaHosting extension method to initialize Lambda. My plan is to allow Action callbacks to be added during the AddAWSLambdaHosting method to provide back the old customization features.

[brendonparker]

Yes, some config or extensibility hooks may solve parts of this.

Let me know if I can be of more help, create a PR, etc.

[normj]

I put out the PR set the HttpContext.TraceIdentifier property. #1172

I haven't add the customization features yet because that one is more complicated and I didn't want getting the trace identifier to be blocked on that. The trouble with customization feature is the parameters to the Action callback change depending on what you are using for LambdaEventSource. So I'm still debating the best solution for that.

[brendonparker]

Sweet!

[normj]

The PR has been released as part of version 7.3.0 of Amazon.Lambda.AspNetCoreServer. Version 1.3.0 of Amazon.Lambda.AspNetCoreServer.Hosting was also released to use the latest version of Amazon.Lambda.AspNetCoreServer in case you are using the library that way.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.