-
Notifications
You must be signed in to change notification settings - Fork 10.3k
Make HttpLogging middleware endpoint aware #47595
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
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
// Licensed to the .NET Foundation under one or more agreements. | ||
// The .NET Foundation licenses this file to you under the MIT license. | ||
|
||
namespace Microsoft.AspNetCore.HttpLogging; | ||
|
||
/// <summary> | ||
/// Metadata that provides endpoint-specific settings for the HttpLogging middleware. | ||
/// </summary> | ||
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)] | ||
public sealed class HttpLoggingAttribute : Attribute | ||
{ | ||
/// <summary> | ||
/// Initializes an instance of the <see cref="HttpLoggingAttribute"/> class. | ||
/// </summary> | ||
/// <param name="loggingFields">Specifies what fields to log for the endpoint.</param> | ||
/// <param name="requestBodyLogLimit">Specifies the maximum number of bytes to be logged for the request body. A value of <c>-1</c> means use the default setting in <see cref="HttpLoggingOptions.RequestBodyLogLimit"/>.</param> | ||
/// <param name="responseBodyLogLimit">Specifies the maximum number of bytes to be logged for the response body. A value of <c>-1</c> means use the default setting in <see cref="HttpLoggingOptions.ResponseBodyLogLimit"/>.</param> | ||
/// <exception cref="ArgumentOutOfRangeException">Thrown when <paramref name="requestBodyLogLimit"/> or <paramref name="responseBodyLogLimit"/> is less than <c>-1</c>.</exception> | ||
public HttpLoggingAttribute(HttpLoggingFields loggingFields, int requestBodyLogLimit = -1, int responseBodyLogLimit = -1) | ||
{ | ||
LoggingFields = loggingFields; | ||
|
||
ArgumentOutOfRangeException.ThrowIfLessThan(requestBodyLogLimit, -1); | ||
ArgumentOutOfRangeException.ThrowIfLessThan(responseBodyLogLimit, -1); | ||
|
||
RequestBodyLogLimit = requestBodyLogLimit; | ||
ResponseBodyLogLimit = responseBodyLogLimit; | ||
} | ||
|
||
/// <summary> | ||
/// Specifies what fields to log. | ||
/// </summary> | ||
public HttpLoggingFields LoggingFields { get; } | ||
|
||
/// <summary> | ||
/// Specifies the maximum number of bytes to be logged for the request body. | ||
/// </summary> | ||
public int RequestBodyLogLimit { get; } | ||
|
||
/// <summary> | ||
/// Specifies the maximum number of bytes to be logged for the response body. | ||
/// </summary> | ||
public int ResponseBodyLogLimit { get; } | ||
} |
34 changes: 34 additions & 0 deletions
34
src/Middleware/HttpLogging/src/HttpLoggingEndpointConventionBuilderExtensions.cs
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
// Licensed to the .NET Foundation under one or more agreements. | ||
// The .NET Foundation licenses this file to you under the MIT license. | ||
|
||
using Microsoft.AspNetCore.HttpLogging; | ||
|
||
namespace Microsoft.AspNetCore.Builder; | ||
|
||
/// <summary> | ||
/// HttpLogging middleware extension methods for <see cref="IEndpointConventionBuilder"/>. | ||
/// </summary> | ||
public static class HttpLoggingEndpointConventionBuilderExtensions | ||
{ | ||
/// <summary> | ||
/// Adds endpoint specific settings for the HttpLogging middleware. | ||
/// </summary> | ||
/// <typeparam name="TBuilder">The type of endpoint convention builder.</typeparam> | ||
/// <param name="builder">The endpoint convention builder.</param> | ||
/// <param name="loggingFields">The <see cref="HttpLoggingFields"/> to apply to this endpoint.</param> | ||
/// <param name="requestBodyLogLimit">Sets the <see cref="HttpLoggingOptions.RequestBodyLogLimit"/> for this endpoint. A value of <c>-1</c> means use the default setting in <see cref="HttpLoggingOptions.RequestBodyLogLimit"/>.</param> | ||
/// <param name="responseBodyLogLimit">Sets the <see cref="HttpLoggingOptions.ResponseBodyLogLimit"/> for this endpoint. A value of <c>-1</c> means use the default setting in <see cref="HttpLoggingOptions.ResponseBodyLogLimit"/>.</param> | ||
/// <returns>The original convention builder parameter.</returns> | ||
/// <exception cref="ArgumentOutOfRangeException">Thrown when <paramref name="requestBodyLogLimit"/> or <paramref name="responseBodyLogLimit"/> is less than <c>-1</c>.</exception> | ||
public static TBuilder WithHttpLogging<TBuilder>(this TBuilder builder, HttpLoggingFields loggingFields, int requestBodyLogLimit = -1, int responseBodyLogLimit = -1) where TBuilder : IEndpointConventionBuilder | ||
{ | ||
// Construct outside build.Add lambda to allow exceptions to be thrown immediately | ||
var metadata = new HttpLoggingAttribute(loggingFields, requestBodyLogLimit, responseBodyLogLimit); | ||
|
||
builder.Add(endpointBuilder => | ||
{ | ||
endpointBuilder.Metadata.Add(metadata); | ||
}); | ||
return builder; | ||
} | ||
} |
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,8 @@ | ||
#nullable enable | ||
Microsoft.AspNetCore.Builder.HttpLoggingEndpointConventionBuilderExtensions | ||
Microsoft.AspNetCore.HttpLogging.HttpLoggingAttribute | ||
Microsoft.AspNetCore.HttpLogging.HttpLoggingAttribute.HttpLoggingAttribute(Microsoft.AspNetCore.HttpLogging.HttpLoggingFields loggingFields, int requestBodyLogLimit = -1, int responseBodyLogLimit = -1) -> void | ||
Microsoft.AspNetCore.HttpLogging.HttpLoggingAttribute.LoggingFields.get -> Microsoft.AspNetCore.HttpLogging.HttpLoggingFields | ||
Microsoft.AspNetCore.HttpLogging.HttpLoggingAttribute.RequestBodyLogLimit.get -> int | ||
Microsoft.AspNetCore.HttpLogging.HttpLoggingAttribute.ResponseBodyLogLimit.get -> int | ||
static Microsoft.AspNetCore.Builder.HttpLoggingEndpointConventionBuilderExtensions.WithHttpLogging<TBuilder>(this TBuilder builder, Microsoft.AspNetCore.HttpLogging.HttpLoggingFields loggingFields, int requestBodyLogLimit = -1, int responseBodyLogLimit = -1) -> TBuilder |
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.