通过

跟踪和消息日志记录

  • 项目

TracingAndLogging 示例演示如何启用跟踪和消息日志记录。 生成的跟踪和消息日志使用服务跟踪查看器工具 (SvcTraceViewer.exe) 进行查看。 此示例基于入门指南。

注意

本主题的最后介绍了此示例的设置过程和生成说明。

跟踪

Windows Communication Foundation (WCF) 使用 System.Diagnostics 命名空间中定义的跟踪机制。 在此跟踪模型中，由应用程序实现的跟踪源生成跟踪数据。 每个源均由名称进行标识。 跟踪使用程序会创建针对要为其检索信息的跟踪源的侦听器。 若要接收跟踪数据，您必须创建针对该跟踪源的侦听器。 在 WCF 中，可通过设置服务模型跟踪源 switchValue 并将下面的代码添加到服务或客户端的配置文件中来实现此目的：

<system.diagnostics>
    <sources>
      <source name="System.ServiceModel" switchValue="Information,ActivityTracing"
        propagateActivity="true">
        <listeners>
          <add name="xml" />
        </listeners>
      </source>
      <source name="System.ServiceModel.MessageLogging">
        <listeners>
          <add name="xml" />
        </listeners>
      </source>
    </sources>
    <sharedListeners>
      <add initializeData="C:\logs\TracingAndLogging-service.svclog" type="System.Diagnostics.XmlWriterTraceListener"
        name="xml" />
    </sharedListeners>
    <trace autoflush="true" />
</system.diagnostics>

有关跟踪源的更多信息，请参见配置跟踪主题中的“跟踪源”一节。

活动跟踪和传播

在客户端和服务的 system.ServiceModel 跟踪源中启用 ActivityTracing 并将 propagateActivity 设置为 true 可在逻辑处理单元（活动）内、在终结点内的多个活动（通过活动传输）之间和在跨多个终结点的多个活动（通过活动 ID 传播）之间关联跟踪。

这三种机制（活动、传输和传播）可帮助您使用服务跟踪查看器工具更快地找到错误的根本原因。 有关详细信息，请参阅使用服务跟踪查看器查看相关跟踪和进行故障诊断。

通过创建用户定义的活动跟踪可以扩展 ServiceModel 提供的跟踪。 用户定义的活动跟踪允许用户创建跟踪活动，以便执行下列操作：

  • 将跟踪分组到逻辑工作单元。

  • 通过传输和传播关联活动。

  • 降低 WCF 跟踪的性能成本（例如，日志文件的磁盘空间成本）。

有关用户定义的活动跟踪的更多信息，请参见扩展跟踪示例。

消息日志记录

可以在任何 WCF 应用程序的客户端和服务上启用消息日志记录。 若要启动消息日志记录，必须将下面的代码添加到客户端或服务：

<configuration>
  <system.serviceModel>
    <diagnostics>
      <!-- Enable Message Logging here. -->
      <!-- log all messages received or sent at the transport or service model levels -->
      <messageLogging logEntireMessage="true"
                      maxMessagesToLog="300"
                      logMessagesAtServiceLevel="true"
                      logMalformedMessages="true"
                      logMessagesAtTransportLevel="true" />
    </diagnostics>
  </system.serviceModel>
</configuration>

记录消息时，跟踪类型取决于是在客户端还是在服务器上进行跟踪。 例如，发送到客户端的“Add”消息将在客户端的“TransportWrite”类别下跟踪，而同一消息将在服务的“TransportRead”类别下跟踪。

通过将下面的代码添加到客户端的 App.config 文件或服务的 Web.config 文件的 System.Diagnostics 节，可以配置跟踪侦听器：

<system.diagnostics>
    <sources>
      <source name="System.ServiceModel" switchValue="Information,ActivityTracing"
        propagateActivity="true">
        <listeners>
          <add name="xml" />
        </listeners>
      </source>
      <source name="System.ServiceModel.MessageLogging">
        <listeners>
          <add name="xml" />
        </listeners>
      </source>
    </sources>
    <sharedListeners>
      <add initializeData="C:\logs\TracingAndLogging-client.svclog" type="System.Diagnostics.XmlWriterTraceListener"
        name="xml" />
    </sharedListeners>
    <trace autoflush="true" />
  </system.diagnostics>

消息将以 XML 格式记录在配置文件中指定的目标目录中。

备注

如果开始时未创建日志目录，则不会创建跟踪文件。 请确保 C:\logs\ 目录存在，或在侦听器配置中指定一个替换日志记录目录。 有关更多信息，请参见本文档最后的初始安装说明。

有关消息日志记录的更多信息，请参见配置消息日志记录主题。

设置、生成和运行示例

  1. 请确保已执行 Windows Communication Foundation 示例的一次性安装过程。

  2. 运行“跟踪和消息日志记录”示例之前，创建 C:\logs\ 目录以便服务向其中写入 .svclog 文件。 此目录的名称在配置文件中定义为要记录的跟踪和消息的路径，并可以进行更改。 向用户授予对日志目录的网络服务写权限。

  3. 要生成 C#、C++ 或 Visual Basic .NET 版本的解决方案，请按照生成 Windows Communication Foundation 示例中的说明进行操作。

  4. 要使用单机配置或跨计算机配置运行示例，请按照运行 Windows Communication Foundation 示例中的说明进行操作。

另请参阅