ASP.NET Web API
CorrelatorSharp.WebApi is an add-on for ASP.NET Web API that enables support for CorrelatorSharp.
Get it
| Where | What |
|---|---|
| NuGet | CorrelatorSharp.WebApi |
| Latest Build (master) |
Using it
Sample: https://github.com/CorrelatorSharp/CorrelatorSharp.WebApi/tree/master/CorrelatorSharp.WebApi.Sample
Step 1: Add the Correlation Filter
public static class WebApiConfig
{
public static void Register(HttpConfiguration config)
{
config.Filters.Add(new CorrelationIdActionFilter());
}
}
Step 2: Consume Correlation
The filter will automatically initialize the current activity scope for correlation based on either a X-Correlation-Id http header in the request or a new random activity id. They will also inject a X-Correlation-Id header into the response.
public IHttpActionResult Test()
{
return Json(ActivityScope.Current.Id);
}
A very simple example of passing in a correlation id as part of a jQuery AJAX call:
<script>
$(function() {
$("#sendRequest").on("click", function () {
$.ajax({
beforeSend: function (xhr) {
xhr.setRequestHeader('X-Correlation-Id', '1234');
},
url: encodeURI('/home/test'),
type: 'POST',
data: {},
contentType: 'application/x-www-form-urlencoded',
success: function (data) { alert("server responded with correlation id: " + data); },
error: function () { },
});
});
});
</script>
<div>
<button id="sendRequest">Send Request with Correlation Id "1234"</button>
</div>