统一日志记录系统 (ULS) 日志记录概述

上次修改时间: 2010年4月15日

适用范围: SharePoint Foundation 2010

本文内容
ULS 日志记录提供哪些好处?
开发人员应该何时使用 ULS 日志记录?
开发人员如何操作 ULS 日志?

长期以来,系统管理员都将有效的日志记录策略作为一种方式来跟踪组件和应用程序问题、为应用程序历史记录提供可计量的统计信息、帮助解决疑难问题以及帮助监视管理员所负责的系统的整体运行状况。

本主题讨论开发人员如何使用 Microsoft SharePoint Foundation 提供的日志记录机制更轻松地开发应用程序、提供更深入的调试信息,以及在遇到问题或达到阈值时与系统管理员进行沟通。主要机制是统一日志记录服务 (ULS),它将 SharePoint Foundation 事件写入 SharePoint 跟踪日志并将它们存储在文件系统中。(注意:ULS 日志有时也称为跟踪日志。)

ULS 日志记录提供哪些好处?

有效实施的 ULS 日志记录可以为下列访问群体提供非常有用的信息。

开发人员

作为开发人员,可以在开发代码时利用跟踪日志。可使用跟踪日志作为开发工具扩展和另一调试工具,以帮助您研究问题。通过确保将有用的信息写入跟踪日志,可以解决在开发过程中出现的很多问题,而无需额外使用调试程序。此外,测试人员可以查看跟踪日志以发现在用户界面 (UI) 中可能看不到的问题,测试人员还可以使用跟踪日志确认长时间运行的任务(可能不具有与操作关联的任何 UI)是否已完成。

对于开发人员来说,ULS 日志记录的另一好处是:无需在 UI 中显示遇到的问题或通知。可以将它们写入数据库以便管理员和开发人员查看和分析。

服务器管理员

若要充分发挥事件日志消息对系统管理员的重要性,事件日志消息中必须包含足够的信息和元数据,以允许系统管理员确定需要执行哪项操作、需要在什么位置执行操作,以及为什么需要执行操作。事件日志中可能包含的其他有用的上下文信息可能是启动操作的用户。很明显,服务器性能和监视对于系统在企业环境中成功运行非常重要,ULS 日志记录可以帮助管理员在部署后微调系统性能。

支持人员

如果出现的问题必须由 Microsoft 客户支持服务部门快速解决,则 ULS 日志可以向支持团队提供有关问题的详细信息,以便更快地解决问题。

警告注释警告

请注意,日志记录文本通常未经过安全修整。因此,在创建日志消息时,请确保不要包含个人或敏感公司信息,否则会将它们写入日志中。

开发人员应该何时使用 ULS 日志记录?

通常,开发人员可以提供的有关代码的信息越详细,就越容易解决可能出现的问题。

开发人员如何操作 ULS 日志?

在 SharePoint Foundation 中,ULS 通过以下两项以两种方式公开可配置设置:

  • 对象模型

  • Windows PowerShell cmdlet

对象模型和 ULS 日志

在 Windows SharePoint Services 3.0 中,对 ULS 日志的访问权限是通过 IDiagnosticsManager 接口提供的。不过,在 SharePoint Foundation 中,建议使用 SPDiagnosticsServiceBase 类。SPDiagnosticsServiceBase 类可封装对 IDiagnosticsManager 类的所有调用,以便开发人员更轻松地与事件日志进行交互。此方法允许您直接写入跟踪服务。

有关使用对象模型操作 ULS 日志的详细信息,请参阅使用跟踪日志记录 API

Windows PowerShell 和 ULS 日志

有关如何在 SharePoint Foundation 中写入 Windows PowerShell cmdlet 以操作 ULS 日志的详细信息,请参阅将 Windows Powershell Cmdlet 和 ULS 日志记录结合使用