Skip to content

Don't log action and page handler arguments above Trace level #9227

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 6 commits into from
Apr 15, 2019
Merged
Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions eng/PatchConfig.props
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ Later on, this will be checked using this condition:
</PropertyGroup>
<PropertyGroup Condition=" '$(VersionPrefix)' == '2.1.11' ">
<PackagesInPatch>
Microsoft.AspNetCore.Mvc.Core;
Microsoft.AspNetCore.Mvc.RazorPages;
</PackagesInPatch>
</PropertyGroup>

Expand Down
45 changes: 31 additions & 14 deletions src/Mvc/Mvc.Core/src/Internal/MvcCoreLoggerExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,15 @@ internal static class MvcCoreLoggerExtensions
private static readonly double TimestampToTicks = TimeSpan.TicksPerSecond / (double)Stopwatch.Frequency;

private static readonly Action<ILogger, string, string, Exception> _actionExecuting;
private static readonly Action<ILogger, string, MethodInfo, string, string, Exception> _controllerActionExecuting;
private static readonly Action<ILogger, string, double, Exception> _actionExecuted;

private static readonly Action<ILogger, string[], Exception> _challengeResultExecuting;

private static readonly Action<ILogger, string, Exception> _contentResultExecuting;

private static readonly Action<ILogger, string, ModelValidationState, Exception> _actionMethodExecuting;
private static readonly Action<ILogger, string, string[], ModelValidationState, Exception> _actionMethodExecutingWithArguments;
private static readonly Action<ILogger, string, string[], Exception> _actionMethodExecutingWithArguments;
private static readonly Action<ILogger, string, string, double, Exception> _actionMethodExecuted;

private static readonly Action<ILogger, string, string[], Exception> _logFilterExecutionPlan;
Expand Down Expand Up @@ -153,6 +154,11 @@ static MvcCoreLoggerExtensions()
1,
"Route matched with {RouteData}. Executing action {ActionName}");

_controllerActionExecuting = LoggerMessage.Define<string, MethodInfo, string, string>(
LogLevel.Information,
3,
"Route matched with {RouteData}. Executing controller action with signature {MethodInfo} on controller {Controller} ({AssemblyName}).");

_actionExecuted = LoggerMessage.Define<string, double>(
LogLevel.Information,
2,
Expand All @@ -173,10 +179,10 @@ static MvcCoreLoggerExtensions()
1,
"Executing action method {ActionName} - Validation state: {ValidationState}");

_actionMethodExecutingWithArguments = LoggerMessage.Define<string, string[], ModelValidationState>(
LogLevel.Information,
1,
"Executing action method {ActionName} with arguments ({Arguments}) - Validation state: {ValidationState}");
_actionMethodExecutingWithArguments = LoggerMessage.Define<string, string[]>(
LogLevel.Trace,
3,
"Executing action method {ActionName} with arguments ({Arguments})");

_actionMethodExecuted = LoggerMessage.Define<string, string, double>(
LogLevel.Information,
Expand Down Expand Up @@ -683,7 +689,22 @@ public static void ExecutingAction(this ILogger logger, ActionDescriptor action)
}
}

_actionExecuting(logger, stringBuilder.ToString(), action.DisplayName, null);
if (action is ControllerActionDescriptor controllerActionDescriptor)
{
var controllerType = controllerActionDescriptor.ControllerTypeInfo.AsType();
var controllerName = TypeNameHelper.GetTypeDisplayName(controllerType);
_controllerActionExecuting(
logger,
stringBuilder.ToString(),
controllerActionDescriptor.MethodInfo,
controllerName,
controllerType.Assembly.GetName().Name,
null);
}
else
{
_actionExecuting(logger, stringBuilder.ToString(), action.DisplayName, null);
}
}
}

Expand Down Expand Up @@ -814,21 +835,17 @@ public static void ActionMethodExecuting(this ILogger logger, ControllerContext
var actionName = context.ActionDescriptor.DisplayName;

var validationState = context.ModelState.ValidationState;
_actionMethodExecuting(logger, actionName, validationState, null);

string[] convertedArguments;
if (arguments == null)
{
_actionMethodExecuting(logger, actionName, validationState, null);
}
else
if (arguments != null && logger.IsEnabled(LogLevel.Trace))
{
convertedArguments = new string[arguments.Length];
var convertedArguments = new string[arguments.Length];
for (var i = 0; i < arguments.Length; i++)
{
convertedArguments[i] = Convert.ToString(arguments[i]);
}

_actionMethodExecutingWithArguments(logger, actionName, convertedArguments, validationState, null);
_actionMethodExecutingWithArguments(logger, actionName, convertedArguments, null);
}
}
}
Expand Down
30 changes: 16 additions & 14 deletions src/Mvc/Mvc.RazorPages/src/Internal/PageLoggerExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ internal static class PageLoggerExtensions
{
public const string PageFilter = "Page Filter";

private static readonly Action<ILogger, string, string[], ModelValidationState, Exception> _handlerMethodExecuting;
private static readonly Action<ILogger, string, ModelValidationState, Exception> _handlerMethodExecuting;
private static readonly Action<ILogger, string, string[], Exception> _handlerMethodExecutingWithArguments;
private static readonly Action<ILogger, string, string, Exception> _handlerMethodExecuted;
private static readonly Action<ILogger, object, Exception> _pageFilterShortCircuit;
private static readonly Action<ILogger, string, string[], Exception> _malformedPageDirective;
Expand All @@ -28,10 +29,15 @@ static PageLoggerExtensions()
{
// These numbers start at 101 intentionally to avoid conflict with the IDs used by ResourceInvoker.

_handlerMethodExecuting = LoggerMessage.Define<string, string[], ModelValidationState>(
_handlerMethodExecuting = LoggerMessage.Define<string, ModelValidationState>(
LogLevel.Information,
101,
"Executing handler method {HandlerName} with arguments ({Arguments}) - ModelState is {ValidationState}");
"Executing handler method {HandlerName} - ModelState is {ValidationState}");

_handlerMethodExecutingWithArguments = LoggerMessage.Define<string, string[]>(
LogLevel.Trace,
103,
"Executing handler method {HandlerName} with arguments ({Arguments})");

_handlerMethodExecuted = LoggerMessage.Define<string, string>(
LogLevel.Debug,
Expand Down Expand Up @@ -75,23 +81,19 @@ public static void ExecutingHandlerMethod(this ILogger logger, PageContext conte
{
var handlerName = handler.MethodInfo.Name;

string[] convertedArguments;
if (arguments == null)
{
convertedArguments = null;
}
else
var validationState = context.ModelState.ValidationState;
_handlerMethodExecuting(logger, handlerName, validationState, null);

if (arguments != null && logger.IsEnabled(LogLevel.Trace))
{
convertedArguments = new string[arguments.Length];
var convertedArguments = new string[arguments.Length];
for (var i = 0; i < arguments.Length; i++)
{
convertedArguments[i] = Convert.ToString(arguments[i]);
}
}

var validationState = context.ModelState.ValidationState;

_handlerMethodExecuting(logger, handlerName, convertedArguments, validationState, null);
_handlerMethodExecutingWithArguments(logger, handlerName, convertedArguments, null);
}
}
}

Expand Down