Add more information and sample to Http.Diagnostics Readme #4808
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
assigned 
geeknoid
approved these changes
Dec 12, 2023
|
Thanks @joperezr for improving the docs! |
CarnaViire
reviewed
Dec 13, 2023
| @@ -55,6 +55,47 @@ builder.Services.AddHttpClientLogEnricher<MyHttpClientLogEnricher>(); | |||
| var host = builder.Build(); | |||
| ``` | |||
|
|
|||
| It is important to note that the `AddExtendedHttpClientLogging` method will add information to the logs using *enrichment*. This means that the information will be added as tags to the structured logs, but will not be visible in the log message that is printed by default in the console. To view the information, you will need to use a logging provider that supports structured logs. One quick and built-in way to do this, is to call `AddJsonConsole()` to your logging builder, which will print out the full structured logs to the console. Here is a quick sample that uses the `ExtendedHttpClientLogging()` method to automatically log all `HttpClient` request and response bodies, and then prints the full structured logs to the console: | |||
There was a problem hiding this comment.
Small nit: the example below would only print the response body, because only ResponseBodyContentTypes is set up, right? And the description says "request and response bodies"
There was a problem hiding this comment.
Good catch! I'll fix that in a follow-up PR.
sebastienros
added a commit
that referenced
this pull request
Dec 18, 2023
* Address issue with legacy logger's calling ToString on the TState arguments. (#4798) * Fix #4795 And while I was in the neighborhood, also addresses #4637 --------- Co-authored-by: Martin Taillefer <mataille@microsoft.com> Co-authored-by: Igor Velikorossov <RussKie@users.noreply.github.com> * Add missing [GeneratedCode] attribute (#4802) The logging code generator emits a static lambda. The lambda's containing function is annotated with the [GeneratedCode] attribute, but the lambda itself is not. The result is that code generators can get confused, considering the lambda as being user code. This PR adds the [GeneratedCode] attribute to the lambda. Co-authored-by: Martin Taillefer <mataille@microsoft.com> * Add more information and sample to Http.Diagnostics Readme (#4808) * Add more information and sample to Http.Diagnostics Readme * Simplify first statement and adding using statements. * Also add extra docs to xml docs * Improve code coverage for M.E.Diagnostics.Testing (#4820) --------- Co-authored-by: Martin Taillefer <geeknoid@users.noreply.github.com> Co-authored-by: Martin Taillefer <mataille@microsoft.com> Co-authored-by: Igor Velikorossov <RussKie@users.noreply.github.com> Co-authored-by: Jose Perez Rodriguez <joperezr@microsoft.com> Co-authored-by: Sébastien Ros <sebastienros@gmail.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding more documentation to the Microsoft.Extensions.Http.Diagnostics package. We got a few reports stating that there is some confusion on how this package is intended to work, so hopefully this extra docs and samples will make it clearer and will help folks hitting issues with this.
cc: @CarnaViire @stephentoub @geeknoid @xakep139
Microsoft Reviewers: Open in CodeFlow