.NET Framework 版本 2.0 的新功能之一是增强型的跟踪系统。 基本前提不变:跟踪消息通过交换机发送到侦听器,侦听器将数据报告给相关联的输出介质。 2.0 版的主要区别是,可以通过 xref:System.Diagnostics.TraceSource 类的实例启动跟踪。 xref:System.Diagnostics.TraceSource 用作增强型跟踪系统,并可用来代替较旧的 xref:System.Diagnostics.Trace 和 xref:System.Diagnostics.Debug 跟踪类的静态方法。 熟悉的 xref:System.Diagnostics.Trace 和 xref:System.Diagnostics.Debug 类仍存在,但建议使用 xref:System.Diagnostics.TraceSource 类进行跟踪。
本主题描述如何将 xref:System.Diagnostics.TraceSource 与应用程序配置文件结合使用。 可在不使用配置文件的情况下使用 xref:System.Diagnostics.TraceSource 进行跟踪,但是不建议这样做。 无需配置文件的跟踪信息,请参阅如何:创建和初始化跟踪源。
创建和初始化跟踪源
-
使用跟踪检测应用程序的第一步是创建跟踪源。 在含有各种组件的大型项目中,可以为每个组件创建一个单独的跟踪源。 建议将应用程序名称作为跟踪源名称。 这会使不同的跟踪更容易保持独立。 以下代码创建一个新的跟踪源 (
mySource)并调用跟踪事件的方法 (Activity1)。 跟踪消息是通过默认跟踪侦听器写入的。using System; using System.Diagnostics; using System.Threading; namespace TraceSourceApp { class Program { private static TraceSource mySource = new TraceSource("TraceSourceApp"); static void Main(string[] args) { Activity1(); mySource.Close(); return; } static void Activity1() { mySource.TraceEvent(TraceEventType.Error, 1, "Error message."); mySource.TraceEvent(TraceEventType.Warning, 2, "Warning message."); } } }
创建和初始化跟踪侦听器和筛选器
-
第一个过程中的代码不会以编程方式标识任何跟踪侦听器或筛选器。 代码本身会产生写入到默认跟踪侦听器的跟踪消息。 若要配置特定的跟踪侦听器及其关联的筛选器,可编辑与应用程序名称对应的配置文件。 在此文件中,可以添加或删除侦听器、为侦听器设置属性和筛选器或删除侦听器。 以下配置文件示例演示如何为在前面过程中创建的跟踪源初始化控制台跟踪侦听器和文本编写器跟踪侦听器。 除配置跟踪侦听器外,配置文件还同时为这两个侦听器创建筛选器,并为跟踪源创建一个源开关。 其中演示了两种添加跟踪侦听器的技术:将侦听器直接添加到跟踪源,以及将侦听器添加到共享的侦听器集合,然后按名称将它添加到跟踪源。 为这两个侦听器标识的筛选器用不同的源级别进行初始化。 这样导致某些消息仅由其中一个侦听器编写。
<configuration> <system.diagnostics> <sources> <source name="TraceSourceApp" switchName="sourceSwitch" switchType="System.Diagnostics.SourceSwitch"> <listeners> <add name="console" type="System.Diagnostics.ConsoleTraceListener"> <filter type="System.Diagnostics.EventTypeFilter" initializeData="Warning"/> </add> <add name="myListener"/> <remove name="Default"/> </listeners> </source> </sources> <switches> <add name="sourceSwitch" value="Warning"/> </switches> <sharedListeners> <add name="myListener" type="System.Diagnostics.TextWriterTraceListener" initializeData="myListener.log"> <filter type="System.Diagnostics.EventTypeFilter" initializeData="Error"/> </add> </sharedListeners> </system.diagnostics> </configuration>
更改侦听器写入跟踪消息的级别
-
配置文件在初始化应用程序时初始化跟踪源的设置。 若要更改这些设置,必须更改配置文件并重启应用,或使用 xref:System.Diagnostics.Trace.Refresh*?displayProperty=nameWithType 方法以编程方式刷新应用程序。 应用程序可以动态更改配置文件设置的属性,以重写用户指定的任何设置。 例如,可能想要确保始终将关键消息发送到文本文件,而不管当前配置设置如何。
using System; using System.Diagnostics; using System.Threading; namespace TraceSourceApp { class Program { private static TraceSource mySource = new TraceSource("TraceSourceApp"); static void Main(string[] args) { Activity1(); // Change the event type for which tracing occurs. // The console trace listener must be specified // in the configuration file. First, save the original // settings from the configuration file. EventTypeFilter configFilter = (EventTypeFilter)mySource.Listeners["console"].Filter; // Then create a new event type filter that ensures // critical messages will be written. mySource.Listeners["console"].Filter = new EventTypeFilter(SourceLevels.Critical); Activity2(); // Allow the trace source to send messages to listeners // for all event types. This statement will override // any settings in the configuration file. mySource.Switch.Level = SourceLevels.All; // Restore the original filter settings. mySource.Listeners["console"].Filter = configFilter; Activity3(); mySource.Close(); return; } static void Activity1() { mySource.TraceEvent(TraceEventType.Error, 1, "Error message."); mySource.TraceEvent(TraceEventType.Warning, 2, "Warning message."); } static void Activity2() { mySource.TraceEvent(TraceEventType.Critical, 3, "Critical message."); mySource.TraceInformation("Informational message."); } static void Activity3() { mySource.TraceEvent(TraceEventType.Error, 4, "Error message."); mySource.TraceInformation("Informational message."); } } }
请参阅
- xref:System.Diagnostics.TraceSource
- xref:System.Diagnostics.TextWriterTraceListener
- xref:System.Diagnostics.ConsoleTraceListener
- xref:System.Diagnostics.EventTypeFilter
- 如何:创建和初始化跟踪源
- 跟踪侦听器
历史资料。此文对应 2019-08-18 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 mairaw)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
