用于控制请求对象的破坏的选项

Question

我遇到了一个问题，我正在努力寻找一个干净的解决方案，谷歌搜索并没有让我变得更明智。

情况

(1) 我们有自己的程序集，用于设置Serilog记录器并将其添加到我们的任何项目中(一致的日志输出、主题等)，并且该程序集没有引用任何消费项目(位于不同的repo中)。让我们称之为CompanySerilog程序集。

(2) 消费项目之一是外部可访问的API，在ExternalContracts程序集中为其定义了"contract"对象。即请求和响应对象以及用作这些对象的一部分的任何枚举。此ExternalContracts程序集可以提供给针对API进行集成的开发人员。

(3) 我们希望记录所有请求，并使用IActionFilter使用Serilog结构化日志记录方法注销每个请求对象。例如，在上下文中对每个参数进行循环，并最终进行_logger.LogDebug("With {name} of {@requestObject}", name, value);

问题

一些请求对象有我们想要屏蔽的敏感数据，但是：

• 当使用标准.Destructure扩展在CompanySerilog中创建记录器时，我们可以定义析构函数的方法，但不知道或想知道请求对象的细节，因为这些对象可能来自Api1、Api2等，这意味着要添加对每个消耗项目的引用
• 我们可以向请求对象(Destructurama.Attributed)添加属性，但这意味着我们的ExternalContracts程序集现在需要对NuGet包的引用，而NuGet包又需要对所有必要的Serilog包的引用。严格地说，在ExternalContracts程序集中不应该需要日志记录问题：这是我们的问题，而不是API的消费者

正如我所说，我一直在努力想出解决这个问题的方法，但在使用IDestructuringPolicy方面找不到太多信息，也找不到它是否合适，或者转换是否应该发挥作用。到目前为止，我只能想到以下选项，但我希望其他人已经遇到了这个问题，并有一种非常聪明和干净的方式来支持这个用例。

解决方案

• 停止结构化日志记录，只为每个请求对象定义一个ToString()，屏蔽我们不想记录的值。这很简单，不需要讨厌的项目交叉引用，也不需要在外部合同中添加日志问题。但这确实意味着不可能进行结构化日志记录。

• 将所有需要的日志引用添加到外部合同中。这将允许我们继续使用内置销毁，但意味着API的消费者将拥有一个包括日志记录程序集的ExternalContracts程序集

• 通过引用将使用此程序集的每个项目，在CompanySerilog中配置日志记录时设置.Destructure值。不会发生的！

• 还有别的吗？请

Answer 1

我们提出了两个潜在的解决方案，如果有人遇到类似的问题，我将分享这两个解决方案-都涉及使用IDestructuringPolicy。

解决方案1

在CompanySerilog部件中具有一个通用IDestructuringPolicy。

public class SensitiveDataDestructuringPolicy : IDestructuringPolicy
{
public bool TryDestructure(object value, ILogEventPropertyValueFactory propertyValueFactory, out LogEventPropertyValue result)
{
var props = value.GetType().GetTypeInfo().DeclaredProperties;
var logEventProperties = new List<LogEventProperty>();
foreach (var propertyInfo in props)
{
switch (propertyInfo.Name.ToLower())
{
case "cardnumber":
case "password":
logEventProperties.Add(new LogEventProperty(propertyInfo.Name,propertyValueFactory.CreatePropertyValue("***")));
break;
default:
logEventProperties.Add(new LogEventProperty(propertyInfo.Name, propertyValueFactory.CreatePropertyValue(propertyInfo.GetValue(value))));
break;
}
}
result = new StructureValue(logEventProperties);
return true;
}
}

并且在设置记录器时，使用以下类型的配置：

var logger = new LoggerConfiguration()
// snipped out all the other things that need configuring
// ...
.Destructure.With<SensitiveDataDestructuringPolicy>
.CreateLogger();

这种方法的优点：

• 一个地方(在日志程序集中)负责决定如何记录对象，而不知道这些对象将是什么类型

这种方法的缺点：

• 这将反映在每个对象的每个属性上，如果只有一个或两个对象需要屏蔽，这就太过分了

由于第一个解决方案的缺点，我们最终选择了不同的方法。

解决方案2

让CompanySerilog中创建记录器的方法在使用它的程序集中查找IDestructuringPolicies。

public static ILogger Create()
{
var destructuringPolicies = GetAllDestructuringPolicies();
var logger = new LoggerConfiguration()
// snipped out all the other things that need configuring
// ...
.Destructure.With(destructuringPolicies)
.CreateLogger();
//Set the static instance of Serilog.Log with the same config
Log.Logger = logger;
logger.Debug($"Found {destructuringPolicies.Length} destructuring policies");
return logger;
}
/// <summary>
/// Finds all classes that implement IDestructuringPolicy, in the assembly that is calling this 
/// </summary>
/// <returns></returns>
private static IDestructuringPolicy[] GetAllDestructuringPolicies()
{
var policies = Assembly.GetEntryAssembly().GetTypes().Where(x => typeof(IDestructuringPolicy).IsAssignableFrom(x));
var instances = policies.Select(x => (IDestructuringPolicy)Activator.CreateInstance(x));
return instances.ToArray();
}

现在，这个CompanySerilog程序集的任何使用者都负责定义它想要如何记录敏感数据，方法是为它关心的每个类定义一个IDestructuringPolicy。例如：

public class RegisterNewUserDestructuringPolicy : IDestructuringPolicy
{
public bool TryDestructure(object value, ILogEventPropertyValueFactory propertyValueFactory, out LogEventPropertyValue result)
{
var request = value as RegisterNewUserRequest;
if (request == null)
{
result = null;
return false;
}
var logEventProperties = new List<LogEventProperty>
{
new LogEventProperty(nameof(request.Claims), propertyValueFactory.CreatePropertyValue(request.Claims)),
new LogEventProperty(nameof(request.Email), propertyValueFactory.CreatePropertyValue(request.Email)),
new LogEventProperty(nameof(request.Password), propertyValueFactory.CreatePropertyValue("****")),
new LogEventProperty(nameof(request.Roles), propertyValueFactory.CreatePropertyValue(request.Roles)),
new LogEventProperty(nameof(request.UserName),
propertyValueFactory.CreatePropertyValue(request.UserName))
};
result = new StructureValue(logEventProperties);
return true;
}
}

与解决方案1相比，这种方法的优势在于，我们现在处理的是具体类型，如果该类型没有策略，那么它就不会被反映出来。

Answer 2

听起来像是适配器模式的一个例子。您不希望外部API有日志记录问题，也不希望CompanySerilog必须了解API中的特殊情况。最好的选择可能是创建一个包装器对象，该对象(临时)保存对请求对象的引用。记录包装器，包装器将只具有您希望在日志中显示的属性。

由于包装器除了包装的对象之外不会保存任何状态，因此它们甚至可以通过池重新使用，以消除GC开销。

大致：

public class Request {
public string Username { get; set; } // log this
public string Password { get; set; } // but not this
}
public class RequestLogWrapper {
public Request WrappedRequest { private get; set; }
public String Username { get { return WrappedRequest.Username; }
}
//To use:
var rlw = new RequestLogWrapper { Request = request };
logger.log("Got a request: {0}", rlw);