使用 log4net 或 NLog 的 WCF 日志记录/跟踪和活动 ID 传播

我见过很多关于日志记录的其他问题。最佳实践。什么日志平台最好。等等。这里有一些关于 SO 的链接，其中对这个主题进行了很好的讨论：

记录最佳实践 https://stackoverflow.com/questions/576185/logging-best-practices

log4net 与 TraceSource https://stackoverflow.com/questions/576456/log4net-versus-tracesource

.NET 3.5 项目的最佳日志记录解决方案 https://stackoverflow.com/questions/98080/what-is-the-best-logging-solution-for-a-c-net-3-5-project

.NET 3.5 日志记录 https://stackoverflow.com/questions/1324321/net-3-5-logging

开始编辑：

写完这篇长文后，我想我想弄清楚的主要问题是 WCF 日志记录/跟踪和活动 ID 传播与 System.Diagnostics 和 TraceSources 的紧密耦合程度。您能否使用 log4net 或 NLog 等第三方日志记录平台获得“良好”的 WCF 日志记录/跟踪和活动 ID 传播。如果你这样做，你会怎么做？

有关 ServiceTraceViewer 的一些问题，请参阅本文底部，

结束编辑。

我的问题的主题在这些帖子中都没有详细讨论。我对人们在日志记录和 WCF 方面所做的事情感兴趣。如果您正在开发一个包含 WCF 服务的项目，并且您已在项目中进行日志记录，那么您是否会做出任何特殊努力来使用特定于 WCF 的日志记录功能。特别是，您是否尝试合并活动跟踪、活动传播和端到端跟踪等内容？如中概述的this http://msdn.microsoft.com/en-us/library/aa751917.aspx文章来自 MSDN。Here http://msdn.microsoft.com/en-us/library/aa738759.aspx是 MSDN 上关于传播活动的另一篇文章。

这些文章很好地解释了如何使用 System.Diagnostics TraceSources 进行活动跟踪、活动传播和端到端跟踪。它展示了如何配置 WCF 以通过 app.config/web.config 文件“打开”这些选项。 WCF 在内部使用 TraceSources 来记录通信结果。

下面是一些示例代码（来自上面链接的第二篇 MSDN 文章），或多或少地展示了如何通过 System.Diagnostics 和 TraceSources 实现活动传播：

TraceSource ts = new TraceSource("myUserTraceSource");
Guid oldID = Trace.CorrelationManager.ActivityId;
Guid traceID = Guid.NewGuid();
ts.TraceTransfer(0, "transfer", traceID);
Trace.CorrelationManager.ActivityId = traceID; // Trace is static
ts.TraceEvent(TraceEventType.Start, 0, "Add request");

double value1 = 100.00D;
double value2 = 15.99D;
ts.TraceInformation("Client sends message to Add " + value1 + ", " + value2);
double result = client.Add(value1, value2);
ts.TraceInformation("Client receives Add response '" + result + "'");

ts.TraceTransfer(0, "transfer", oldID);
ts.TraceEvent(TraceEventType.Stop, 0, "Add request");
Trace.CorrelationManager.ActivityId = oldID;

您可以通过以下方法从服务内部判断 WCF 是否已传播活动：

// Check if an activity was set in scope by WCF, i.e., if it was 
// propagated from the client. If not, i.e., ambient activity is 
// equal to Guid.Empty, create a new one.
if(Trace.CorrelationManager.ActivityId == Guid.Empty)
{
    Guid newGuid = Guid.NewGuid();
    Trace.CorrelationManager.ActivityId = newGuid;
}
// Emit your Start trace.
ts.TraceEvent(TraceEventType.Start, 0, "Add Activity");

// Emit the processing traces for that request.
serviceTs.TraceInformation("Service receives Add " 
                        + n1 + ", " + n2);
// double result = n1 + n2;
serviceTs.TraceInformation("Service sends Add result" + result);

// Emit the Stop trace and exit the method scope.
ts.TraceEvent(TraceEventType.Stop, 0, "Add Activity");
// return result;

从我看到的所有示例中，活动传播是通过配置（通常通过 app.config）System.Service 模型 TraceSource 并将其propagateActivity 属性设置为“true”来实现的。活动实际上是通过在 Trace.CorrelationManager.ActivityId 上设置活动 id (guid) 来传播的。如果您使用 log4net 或 NLog，可以有效地使用 WCF 日志记录和活动传播吗？

我的项目将大量使用 WCF。我们目前正在尝试确定我们的日志记录解决方案。我认为我对 WCF 日志记录和活动传播如何与 System.Diagnostics 和 TraceSources 一起工作有很好的理解。我想更好地了解如何/是否可以使用 log4net 和 NLog 等日志平台来实现类似的功能。

他们提供一些“本地”支持吗？他们似乎更有可能提供一些基础设施，以便可以“手动”实现活动传播。也许是这样的：

//Inside client code:
ILog logger = LogManager.GetLogger("client");
Guid oldActivity = Trace.CorrelationManager.ActivityId;
if (oldActivity == Guid.Empty)
{
  Trace.CorrelationManager.ActivityId = Guid.NewGuid();
}

using (LogManager.NDC.Push(Trace.CorrelationManager.ActivityId))
{
  log.Info("Before calling WCF Service");

  wcfService.Method();

  log.Info("After calling WCF Service");
}
Trace.CorrelationManager.ActivityId = oldActivity;

如果 log4net/NLog 日志记录格式配置为记录 NDC 堆栈的顶部，则客户端记录的每条消息（当活动在范围内时）都将使用活动 ID 进行“标记”。假设 WCF 服务的实现类似，那么在服务调用期间记录的所有消息也将被记录（尽管可能在单独的文件中）并使用相同的活动 ID 进行标记。因此，可以将“服务”日志文件中的日志消息与“客户端”日志中的相应消息相关联。

因此，如果您使用 WCF 并且有日志记录，那么这里有一些问题：

1. 您使用活动传播吗？
2. 您使用 TraceSources 进行日志记录吗？
3. 您是否使用其他日志平台（例如 log4net、NLog）？
4. 如果您使用其他日志平台，如何进行活动传播？
5. 您是否混合使用第三方日志记录（log4net/NLog - 对于大多数日志记录）和System.Diagnostics.TraceSource（对于 WCF 服务边界日志记录）？

ServiceTraceViewer 怎么样？你用它吗？我见过的大多数示例都显示 System.Diagnostics 通过 TraceSources 和 XmlTraceListener 生成的输出。它可以使用 log4net、NLog 等的输出吗？它与基于 TraceSource 的日志记录一起工作是否“最佳”？如果是这样，那么在 WCF 服务边界处有一点基于 TraceSource 的日志记录（捕获一些应用程序上下文以及 WCF 通信信息）以便在 ServiceTraceViewer 中查看是否“足够好”？我曾短暂使用过 ServiceTraceViewer，作为我正在进行的 WCF 学习过程的一部分。

如果您读到这里，感谢您的阅读。也许我对日志记录、WCF 活动传播以及在 ServiceTraceViewer 中查看日志的能力的整体集成考虑过多。这似乎是选择日志平台和/或日志策略时的一个重要考虑因素，但我对这些日志平台或 WCF 没有足够的经验来确定。

只是我的镍值，我使用我自己编写/维护的基于 AOP 的日志记录，但它就像其他一些日志记录框架一样......我的框架基于装饰器，但我可以将其扩展到调用堆栈上的任何内容。

所以你有这样的东西：

using (LogManager.NDC.Push(Trace.CorrelationManager.ActivityId)) {
  log.Info("Before calling WCF Service");

  wcfService.Method();

  log.Info("After calling WCF Service");
}
Trace.CorrelationManager.ActivityId = oldActivity;

如果您的服务器上有类似的东西，那么我的方法可以在这方面起作用，但我的方法对于内部日志记录不起作用。我的设置是为了执行此操作：

[LogMethod( CaptureDirection = LoggingDirection.InOut /*Optional*/, CaptureVariables = Yes /*Optional*/ )]
public ClassName MyMethodName(params){
  //magic logging happens here on method entry

  DoSomething();

  //if you need logging here I can't do anything with my AOP system

  DoSomethingElse();


  //magic logging happens here on method exit
}

此外，您是否希望在客户端和服务器之间建立关联的日志记录？这两个人如何谈判？您如何确保其中一个与另一个相关？