Skip to content

Add comment about RequestQuery #42978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 1, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/Middleware/HttpLogging/src/HttpLoggingFields.cs
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,10 @@ public enum HttpLoggingFields : long
/// Logging the request body has performance implications, as it requires buffering
/// the entire request body up to <see cref="HttpLoggingOptions.RequestBodyLogLimit"/>.
/// </summary>
/// <remarks>
/// The HTTP Request <see cref="HttpRequest.QueryString"/> is not included with this flag as it may contain private information.
/// If desired, it should be explicitly specified with <see cref="RequestQuery"/>.
/// </remarks>
Request = RequestPropertiesAndHeaders | RequestBody,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this comment get added to RequestProperties as well?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


/// <summary>
Expand All @@ -175,5 +179,9 @@ public enum HttpLoggingFields : long
/// the entire request and response body up to the <see cref="HttpLoggingOptions.RequestBodyLogLimit"/>
/// and <see cref="HttpLoggingOptions.ResponseBodyLogLimit"/>.
/// </summary>
/// <remarks>
/// The HTTP Request <see cref="HttpRequest.QueryString"/> is not included with this flag as it may contain private information.
/// If desired, it should be explicitly specified with <see cref="RequestQuery"/>.
/// </remarks>
All = Request | Response
}