How to add annotations for every request?

[Kralizek]

I have an ASP.NET Core application and I want to add an annotation to the trace of each request flowing through this application and I wonder what's the best approach.

My first idea would be to use the Startup constructor but I'm not sure if that would work.

public Startup(IConfiguration configuration, IHostEnvironment hostEnvironment)
{
    AWSXRayRecorder.InitializeInstance(configuration);
    AWSXRayRecorder.RegisterLogger(GetLoggingOptions(configuration));
    AWSSDKHandler.RegisterXRayForAllServices();

    Configuration = configuration;
    HostEnvironment = hostEnvironment;

    AWSXRayRecorder.Instance.AddAnnotation("Project", "MY_SECRET_PROJECT");
    AWSXRayRecorder.Instance.AddAnnotation("Environment", HostEnvironment.EnvironmentName);
    AWSXRayRecorder.Instance.AddAnnotation("Workspace", GetWorkspaceName());
}

Alternatively, I was considering adding an extra step in the pipeline add the snippet below in the Configure method

app.Use(next =>
{
    AWSXRayRecorder.Instance.AddAnnotation("Project", "MY_SECRET_PROJECT");
    AWSXRayRecorder.Instance.AddAnnotation("Environment", HostEnvironment.EnvironmentName);
    AWSXRayRecorder.Instance.AddAnnotation("Workspace", GetWorkspaceName());
    return next;
});

Ideally, it would be nice if UseXRay had an overload that accepted a delegate of type Action<HttpContext, AWSXRayRecorder> for this kind of configuration (unless there is a better approach).

app.UseXRay("MY_COMPONENT", (_, recorder) => 
{
    recorder.AddAnnotation("Project", "MY_SECRET_PROJECT");
    recorder.AddAnnotation("Environment", HostEnvironment.EnvironmentName);
    recorder.AddAnnotation("Workspace", GetWorkspaceName());
});

[lupengamzn]

Hi @Kralizek,

I believe you can do so by adding an extra middleware specifically for adding annotation in the pipeline.

[Kralizek]

Hi @lupengamzn

So something like the snippet below?

app​.​Use​(​next​ ​=>​
{
    ​AWSXRayRecorder​.​Instance​.​AddAnnotation​(​"​Project​"​, ​"​MY_SECRET_PROJECT​"​);
    ​AWSXRayRecorder​.​Instance​.​AddAnnotation​(​"​Environment​"​, ​HostEnvironment​.​EnvironmentName​);
    ​AWSXRayRecorder​.​Instance​.​AddAnnotation​(​"​Workspace​"​, ​GetWorkspaceName​());
    ​return​ ​next​;
});

[arash-bizcover]

How can we just add annotations into the Incoming requests? any config in the .useXray() we can use ?

@srprash do you know/ have any snippet that works?