我应该在TraceSource.TraceEvent方法中使用id参数识别什么?
我使用TraceSource类来登录我的.NET项目。
然而,我从未明确过的一点是, TraceEvent
方法中id
参数的意图是什么。 目前,我总是把它设置为0。
但它的预期或典型有用用途是什么?
我可以想到几个可能性:
- 它是事件发生的ID(即同一行代码在每次执行时产生不同的ID);
- 它是方法调用的ID(即,您可以从ID推断出代码行);
- 它是一系列类似事件的ID(例如,表示数据库不存在的所有错误消息共享相同的ID);
- 它是与逻辑操作相关的一组事件的ID,与
TraceEventType.(Start|Stop|Suspend|Resume|Transfer)
结合使用TraceEventType.(Start|Stop|Suspend|Resume|Transfer)
枚举值;
我问自己同样的问题,我在任何Microsoft文档中都没有找到任何澄清这一点。 我找到的是一篇由Microsoft MVP Richard Grimes撰写的文章: “id参数是你选择它的任何东西,没有强迫特定ID与特定格式消息相关联。” 在所有示例中,他使用0作为id参数。
在MSDN文章中,我看到它使用随机,不提供任何其他信息。 我相信只要你保持相同的代码约定,你就可以在阅读日志时以任何方式使用它们。 如果你想使用接受id参数的SourceFilter.ShouldTrace方法,那么之后在跟踪过滤中它可能会很有用。
我用它来描述错误类型,如果我有错误,或使用0表示其他任何内容。
就我在文档中看到的而言,它并非专门用于一个目的。 我认为你可以使用自己的逻辑跟踪事件。 SourceFilter
上的ShouldTrace()
方法采用匹配的id
参数,因此您还可以使用它来确定哪些事件或事件类型在哪里。
就个人而言,当我使用TraceSource
(事实上它并不多,最近才发现它)时,我用它来跟踪事件类型或类别。 在一个应用程序中,我已经有一个事件类型的枚举,我正在使用另一个日志记录方法,值为Debug,Info,Warn,Error,Fatal,所以我将其转换为int
并将其用作id
,这有助于以后过滤所以我可以过滤掉我感兴趣的水平之下的任何东西,以消除痕迹。
另一种可能性是您可以使用不同的值来关联应用程序的不同部分,因此数据访问= 1,用户帐户= 2,产品逻辑= 3,通知= 4,UI = 5等。再次,您可以使用此将跟踪过滤到您正在查看的事物的类型。
或者,您可以(如您所建议的)使用不同的id
值来表示不同的事件类型,因此您可以像错误代码一样使用它们(例如)每当您看到id
为26时,您就知道数据库连接可以不成立,或其他什么。
使用id
参数的内容并不特别重要,只要:
- 它对您构建和调试程序很有用
- 阅读代码的程序员清楚易懂
- 它在整个计划中始终如一地使用
一种可能性是,您可以拥有一个集中式类来管理事件id
并根据某种输入提供值,以确保整个应用程序对同一事物使用相同的id
。