此示例演示如何将您自己的跟踪事件添加到 Windows Communication Foundation (WCF) 将写入到 ETW 中的分析跟踪流.NET Framework 4.6.1。 跟踪分析是为了便于查看服务,而不会导致较高性能损失。 此示例演示如何使用xref:System.Diagnostics.Eventing?displayProperty=nameWithTypeApi 来与 WCF 服务集成的写入事件。
有关详细信息xref:System.Diagnostics.Eventing?displayProperty=nameWithTypeApi,请参阅xref:System.Diagnostics.Eventing?displayProperty=nameWithType。
若要了解有关在 Windows 事件跟踪的详细信息,请参阅改善调试和性能优化使用 ETW。
释放 EventProvider
此示例使用 xref:System.Diagnostics.Eventing.EventProvider?displayProperty=nameWithType 类,该类实现 xref:System.IDisposable?displayProperty=nameWithType。 在实现对 WCF 服务的跟踪时,很可能,您可以使用xref:System.Diagnostics.Eventing.EventProvider的服务的生命周期的资源。 因此,为了便于阅读,此示例永远不会释放已包装的 xref:System.Diagnostics.Eventing.EventProvider。 如果出于某种原因,您的服务具有不同的跟踪需求,并且必须释放此资源,则应根据释放非托管资源的最佳做法来修改此示例。 释放非托管的资源的详细信息,请参阅实现 Dispose 方法。
自我承载与Web 承载
对于 Web 承载的服务,WCF 的分析跟踪提供了一个名为"HostReference",用于标识发出这些跟踪服务的字段。 可扩展的用户跟踪可以参与此模型,此示例演示执行该操作的最佳做法。 Web 主机的格式引用时管道|字符实际显示在生成字符串可以是以下之一:
-
如果该应用程序不在根处。
<SiteName><ApplicationVirtualPath>|<ServiceVirtualPath>|<ServiceName>
-
如果该应用程序在根处。
<SiteName>|<ServiceVirtualPath>|<ServiceName>
对于自承载服务,WCF 的分析跟踪不会填充"HostReference"字段。 此示例中的 WCFUserEventProvider 类在由自承载服务使用时,其行为是一致的。
自定义事件详细信息
WCF 的 ETW 事件提供程序清单定义了三个旨在由 WCF 服务作者从服务代码内发出的事件。 下表显示了这三个事件的分类。
| Event | 描述 | 事件 ID |
|---|---|---|
| UserDefinedInformationEventOccurred | 服务中发生的说明内容不是一个问题时发出此事件。 例如,可以在对数据库成功进行调用后发出一个事件。 | 301 |
| UserDefinedWarningOccurred | 发生的问题可能导致将来出现错误时发出此事件。 例如,如果调用数据库失败,但能够通过回退到冗余数据存储区进行恢复,则可以发出一个警告事件。 | 302 |
| UserDefinedErrorOccurred | 服务的行为方式不符合预期时发出此事件。 例如,如果调用数据库失败且无法从其他位置检索数据,则可能会发出一个事件。 | 303 |
使用此示例
-
使用 Visual Studio 2012 打开 WCFAnalyticTracingExtensibility.sln 解决方案文件。
-
要生成解决方案,按 Ctrl+Shift+B。
-
若要运行解决方案,请按 Ctrl+F5。
在 Web 浏览器中,单击calculator.svc。 服务的 WSDL 文档的 URI 应出现在浏览器中。 复制该 URI。
-
运行 WCF 测试客户端 (WcfTestClient.exe)。
WCF 测试客户端 (WcfTestClient.exe) 位于
\<Visual Studio 2012 Install Dir>\Common7\IDE\WcfTestClient.exe。 默认 Visual Studio 2012 安装目录是C:\Program Files\Microsoft Visual Studio 10.0。 -
在 WCF 测试客户端,通过选择添加服务文件,然后添加的服务。
在输入框中添加终结点地址。
-
单击确定关闭对话框。
ICalculator 服务下的左窗格中添加我的服务项目。
-
打开事件查看器应用程序。
然后再调用该服务,启动事件查看器,并确保事件日志正在侦听从 WCF 服务发出的跟踪事件。
-
从启动菜单中,选择管理工具,然后事件查看器。 启用Analytic并调试日志。
-
在事件查看器中树视图中,导航到事件查看器,应用程序和服务日志, Microsoft, Windows,,然后应用程序服务器-应用程序。 右键单击应用程序服务器-应用程序,选择视图,然后显示分析和调试日志。
絋粄显示分析和调试日志选项处于选中状态。 启用分析日志。
在事件查看器中树视图中,导航到事件查看器,应用程序和服务日志, Microsoft, Windows, 应用程序服务器-应用程序,然后分析。 右键单击Analytic ,然后选择启用日志。
-
使用 WCF 测试客户端来测试服务。
-
在 WCF 测试客户端中,双击add () ICalculator 服务节点下。
Add () 方法将出现在右窗格中使用两个参数。
-
为第一个参数键入 2,为第二个参数键入 3。
-
单击Invoke来调用该方法。
-
-
转到事件查看器已打开的窗口。 导航到事件查看器,应用程序和服务日志, Microsoft, Windows,应用程序服务器应用程序。
-
右键单击Analytic节点,然后选择刷新。
事件将显示在右窗格中。
-
使用 ID 303 来查找事件,然后双击该事件将其打开,并检查其内容。
已将发出此事件
Add()ICalculator 服务的方法和具有负载等于"2 + 3 = 5"。
清理(可选)
-
打开事件查看器。
-
导航到事件查看器,应用程序和服务日志, Microsoft, Windows,,然后应用程序服务器-应用程序。 右键单击Analytic ,然后选择禁用日志。
-
导航到事件查看器,应用程序和服务日志, Microsoft, Windows, 应用程序服务器-应用程序,然后分析。 右键单击Analytic ,然后选择清除日志。
-
单击清除清除这些事件。
已知问题
没有中的已知的问题事件查看器,它可能无法解码 ETW 事件。 可能会看到错误消息,指出:"事件 ID 的说明<id > 找不到 Microsoft Windows 应用程序服务器-应用程序的源中。 本地计算机上未安装引发此事件的组件,或者安装已损坏。 你可以安装或修复本地计算机上的组件。" 如果遇到此错误,请选择刷新从操作菜单。 然后,该事件应能正确解码。
Important: 您的计算机上可能已安装这些示例。 在继续操作之前,请先检查以下(默认)目录:
<InstallDrive>:\WF_WCF_Samples如果此目录不存在,请转到Windows Communication Foundation (WCF) 和.NET Framework 4 的 Windows Workflow Foundation (WF) 示例若要下载所有 Windows Communication Foundation (WCF) 和WF示例。 此示例位于以下目录:
<InstallDrive>:\WF_WCF_Samples\WCF\Basic\Management\ETWTrace
请参阅
历史资料。此文对应 2019-08-18 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站展开固定版本仓库内的引用内容,将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
