Shulou(Shulou.com)06/02 Report--

This article mainly introduces "how to use the .NET 6 middleware Http Logging". In the daily operation, I believe many people have doubts about how to use the .NET 6 middleware Http Logging. The editor consulted all kinds of materials and sorted out simple and easy-to-use operation methods. I hope it will be helpful to answer the doubts about "how to use the .NET 6 middleware Http Logging". Next, please follow the editor to study!

Intro

.net 6 will introduce a Http logging middleware, which can be used to help us record request and response information more easily.

Sample

Don't talk too much nonsense, let's take a look at the example

Var builder = WebApplication.CreateBuilder (args); builder.Services.AddControllers (); var app = builder.Build (); app.UseHttpLogging (); app.MapControllers (); app.Run ()

Dotnet run runs the project, and then visits an interface to see the printed Http logging log.

Info: Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware [1] Request: Protocol: HTTP/1.1 Method: GET Scheme: Path: / weatherforecast Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9 Connection: keep-alive Host: localhost:5084 User-Agent: Mozilla/5.0 (Windows NT 10.0 Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/94.0.4606.54 Safari/537.36 Accept-Encoding: gzip, deflate, br Accept-Language: zh-CN,zh;q=0.9,en-US;q=0.8,en Qroom0.7 Cache-Control: [Redacted] Upgrade-Insecure-Requests: [Redacted] sec-ch-ua: [Redacted] sec-ch-ua-mobile: [Redacted] sec-ch-ua-platform: [Redacted] Sec-Fetch-Site: [Redacted] Sec-Fetch-Mode: [Redacted] Sec-Fetch-User: [Redacted] Sec-Fetch-Dest: [Redacted ] info: Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware [2] Response: StatusCode: 200 Content-Type: application/json Charset=utf-8 Date: [Redacted] Server: [Redacted] Transfer-Encoding: chunked

By default, HttpLoggingMiddleware records the basic information of the request (request address, protocol version) and request header information, as well as response status and response header information. For request headers and response headers that are not in the default list, the value is displayed as [Redacted]. If you need to record the value of this request header / response header, you need to configure HttpLoggingOptions, which can be configured when registering the service. The configuration example is as follows:

Builder.Services.AddHttpLogging (options = > {options.RequestHeaders.Add ("Cache-Control"); options.ResponseHeaders.Add ("Server");})

After modification, restart and request our service. The log output is as follows:

Info: Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware [1] Request: Protocol: HTTP/1.1 Method: GET Scheme: Path: / weatherforecast Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9 Connection: keep-alive Host: localhost:5084 User-Agent: Mozilla/5.0 (Windows NT 10.0 Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/94.0.4606.54 Safari/537.36 Accept-Encoding: gzip, deflate, br Accept-Language: zh-CN,zh;q=0.9,en-US;q=0.8,en Qroom0.7 Cache-Control: max-age=0 Upgrade-Insecure-Requests: [Redacted] sec-ch-ua: [Redacted] sec-ch-ua-mobile: [Redacted] sec-ch-ua-platform: [Redacted] Sec-Fetch-Site: [Redacted] Sec-Fetch-Mode: [Redacted] Sec-Fetch-User: [Redacted] Sec-Fetch-Dest: [Redacted] info : Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware [2] Response: StatusCode: 200 Content-Type: application/json Charset=utf-8 Date: [Redacted] Server: Kestrel Transfer-Encoding: chunked

Notice that the Cache-Control in the request header and the Server in the response header are both [Redacted]. After configuration, the correct value is displayed. If you want to record the custom request header information, it is a similar configuration.

Then let's configure the recording request information and response information. You can configure LoggingFields in HttpLoggingOptions to specify what information needs to be recorded.

Builder.Services.AddHttpLogging (options = > {options.LoggingFields = Microsoft.AspNetCore.HttpLogging.HttpLoggingFields.All; options.RequestHeaders.Add ("Cache-Control"); options.ResponseHeaders.Add ("Server");})

Add the configuration of LoggingFields based on the above. Here, configure all the information directly. Request again at this time. Check the log as follows:

Info: Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware [1] Request: Protocol: HTTP/1.1 Method: GET Scheme: http PathBase: Path: / weatherforecast Host: localhost:5084 User-Agent: dotnet-HTTPie/0.1.1info: Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware [2] Response: StatusCode: 200 Content-Type: application/json Charset=utf-8info: Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware [4] ResponseBody: [{"date": "2021-09-25T23:40:11.0164783+08:00", "temperatureC": 37, "temperatureF": 98, "summary": "Cool"}, {"date": "2021-09-26T23:40:11.0164836+08:00", "temperatureC": 50, "temperatureF": 121," summary ":" Warm "}, {" date ":" 2021-09-27T23:40:11.0164838+08:00 " "temperatureC":-7, "temperatureF": 20, "summary": "Scorching"}, {"date": "2021-09-28T23:40:11.016484+08:00", "temperatureC": 39, "temperatureF": 102, "summary": "Freezing"}, {"date": "2021-09-29T23:40:11.0164842+08:00", "temperatureC": 4, "temperatureF": 39, "summary": "Balmy"}]

You can see that the response body is also recorded at this time.

Let's add an API of POST to verify whether the RequestBody can be recorded properly.

[HttpPost] public IActionResult Post (System.Text.Json.JsonElement element) = > Ok (element)

Use dotnet-httpie to execute http: 5084/weatherforecast name=test

Request API. The output log is as follows:

Info: Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware [1] Request: Protocol: HTTP/1.1 Method: POST Scheme: http PathBase: Path: / weatherforecast Host: localhost:5084 User-Agent: dotnet-HTTPie/0.1.1 Content-Type: application/json Charset=utf-8 Content-Length: 15info: Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware [3] RequestBody: {"name": "test"} info: Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware [2] Response: StatusCode: 200Content-Type: application/json Charset=utf-8info: Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware [4] ResponseBody: {"name": "test"} at this point, the study on "how to use the .NET 6 middleware HttpLogging" is over. I hope I can solve your doubts. The collocation of theory and practice can better help you learn, go and try it! If you want to continue to learn more related knowledge, please continue to follow the website, the editor will continue to work hard to bring you more practical articles!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.