How to log request header information for SoapCore web service call

SK Azharuddin 0

Development details

.Net 6

SoapCore (1.0.0)

Currently, I am implemented IClientMessageInspector and IEndpointBehavior Interface to log SoapCore web service call request response (Only request message and response message).

Using this implementation process I'm able to log request and response message information.

Using this implementation process I'm not able to log request and response header information.

How could I log request and response header information for the SoapCore web service call?

Zhi Lv - MSFT 32,011 Microsoft Vendor

Hi @SK Azharuddin

You can try to create a custom middleware to capture both HTTP requests and responses.

Code like this:

public class RequestResponseLoggerMiddleware  
{  
    private readonly RequestDelegate _next;  
    private readonly bool _isRequestResponseLoggingEnabled;  
  
    public RequestResponseLoggerMiddleware(RequestDelegate next, IConfiguration config)  
    {  
        _next = next;  
        _isRequestResponseLoggingEnabled = config.GetValue<bool>("EnableRequestResponseLogging", false);  
    }  
  
    public async Task InvokeAsync(HttpContext httpContext)  
    {  
        // Middleware is enabled only when the EnableRequestResponseLogging config value is set.  
        if (_isRequestResponseLoggingEnabled)  
        {  
            Console.WriteLine($"HTTP request information:\n" +  
                $"\tMethod: {httpContext.Request.Method}\n" +  
                $"\tPath: {httpContext.Request.Path}\n" +  
                $"\tQueryString: {httpContext.Request.QueryString}\n" +  
                $"\tHeaders: {FormatHeaders(httpContext.Request.Headers)}\n" +  
                $"\tSchema: {httpContext.Request.Scheme}\n" +  
                $"\tHost: {httpContext.Request.Host}\n" +  
                $"\tBody: {await ReadBodyFromRequest(httpContext.Request)}");  
  
            // Temporarily replace the HttpResponseStream, which is a write-only stream, with a MemoryStream to capture it's value in-flight.  
            var originalResponseBody = httpContext.Response.Body;  
            using var newResponseBody = new MemoryStream();  
            httpContext.Response.Body = newResponseBody;  
  
            // Call the next middleware in the pipeline  
            await _next(httpContext);  
  
            newResponseBody.Seek(0, SeekOrigin.Begin);  
            var responseBodyText = await new StreamReader(httpContext.Response.Body).ReadToEndAsync();  
  
            Console.WriteLine($"HTTP request information:\n" +  
                $"\tStatusCode: {httpContext.Response.StatusCode}\n" +  
                $"\tContentType: {httpContext.Response.ContentType}\n" +  
                $"\tHeaders: {FormatHeaders(httpContext.Response.Headers)}\n" +  
                $"\tBody: {responseBodyText}");  
  
            newResponseBody.Seek(0, SeekOrigin.Begin);  
            await newResponseBody.CopyToAsync(originalResponseBody);  
        }  
        else  
        {  
            await _next(httpContext);  
        }  
    }  
  
    private static string FormatHeaders(IHeaderDictionary headers) => string.Join(", ", headers.Select(kvp => $"{<!-- -->{<!-- -->{kvp.Key}: {string.Join(", ", kvp.Value)}}}"));  
  
    private static async Task<string> ReadBodyFromRequest(HttpRequest request)  
    {  
        // Ensure the request's body can be read multiple times (for the next middlewares in the pipeline).  
        request.EnableBuffering();  
  
        using var streamReader = new StreamReader(request.Body, leaveOpen: true);  
        var requestBody = await streamReader.ReadToEndAsync();  
  
        // Reset the request's body stream position for next middleware in the pipeline.  
        request.Body.Position = 0;  
        return requestBody;  
    }  
}

Then, call the custom middleware using app.UseMiddleware<RequestResponseLoggerMiddleware>(); or create a Custom middleware extension.

More detail information, refer to the following articles:

AspNetCoreRequestResponseLogger

ASP.NET Core Web API how to log requests and responses into database

Request Response Logging Middleware ASP.NET Core

Best regards,
Dillion