日志记录

诊断日志记录的作用是在应用程序执行时提供更多信息。记录的错误和警告可以帮助查明最终用户可能无法立即发现的系统内故障。可以临时启用更详细的日志记录,以方便用户在解决问题时更好地了解应用程序行为。

Blue Prism 使用经过验证的可靠库 NLog 来输出和记录日志信息。管理员可以调整在全局或应用程序的特定区域中记录的信息量。

日志记录级别

日志条目按级别分类。信息或以上级别的条目通常记录为标准条目。较低、更详细的级别(如调试跟踪)可提供更详细的信息,但需要启用。

NLog 定义了以下级别:

  • 跟踪—非常详细的日志,其中可能包含大量信息,如协议有效负载。此日志级别通常仅在开发期间启用。
  • 调试—调试信息,不如跟踪信息详细,由于可能对性能产生影响,通常未在生产环境中启用。
  • 信息—信息消息,通常在生产环境中正式启用。
  • 警告—警告消息,通常用于非关键问题,这些问题可以恢复或者是临时故障。
  • 错误—错误消息,大多数是异常。
  • 严重—非常严重的错误。

标准日志记录配置

在安装文件夹中的 appsettings.json 文件内为每个网站和服务定义日志记录级别。对于默认安装,这些文件夹位于 C:\Program Files (x86)\Blue Prism\ 下面。

在正常使用期间,您不需要自行修改 appsettings.json 文件中的日志配置设置。在调查产品问题时,Blue Prism 客户支持将提供备用日志配置设置。如果 appsettings.json 文件中更改了日志记录设置,则站点需要在 IIS 内重新启动。

修改日志记录配置可能会影响应用程序的性能,如果在生产环境中进行修改,则应特别小心。

默认配置将信息级别及以上的日志条目(包括警告、错误和严重错误)写入日志文件。日志文件写入 appsettings.json 文件中 LogsFolder 设置指定的目录,通常设置为 ./Logs_{Application},例如 ./Logs_Hub 或 ./Logs_Interact。

默认情况下,appsettings.json 文件中的日志记录配置设置如下:

复制
"Logging": {
      "LogsFolder": "./Logs_{Application}",
      "LogLevel": {
        "Default": "Information",
        "System": "Warning",
        "Microsoft": "Warning"
      }
    },

根据日志级别和日期生成单独的日志文件,级别和日期反映在日志文件名中,例如 warns.2021-05-07 或 infos.2021-05-07。

以下是信息日志文件中一行的示例:

[08:58:11.4549] Connect.Core.Actions.UpdateCacheAction—小组件的 Cache 已更新

此文本的格式包含以下元素:

  • 时间(使用服务器上设置的时区)—日期反映在文件名中。
  • 记录器名称—这通常用于标识日志条目所源自的类和命名空间。
  • 日志消息。
  • 错误信息—仅当记录异常信息时可用。完整详细信息记录于日志消息下面的单独行。

其他日志记录配置

Blue Prism 开发了额外的日志记录配置设置,可添加到相应的 appsettings.json 文件,以捕获某些组件的活动。

调试 LDAP

您可以配置日志记录,帮助调试将 Hub 与 LDAP 同步时可能出现的任何问题。您需要先在 Authentication Server appsettings.json 文件中设置日志记录,然后才能在 Hub UI 中同步用户。

  1. 在服务器上,导航至 Authentication Server 文件夹。默认情况下,其位于 C:\Program Files (x86)\Blue Prism\ 之中。
  2. 在文本编辑器中打开 appsettings.json 文件。
  3. 找到 Logging 部分并添加“ImsServer.IntegrationServices.Services.LdapConnectionService”:调试到 LogLevel 部分,并在以上行末尾插入逗号,例如:

    复制
    "Logging": {
          "LogsFolder": "./Logs_AuthenticationServer",
          "LogLevel": {
            "Default": "Information",
            "System": "Warning",
            "Microsoft": "Warning",
            "ImsServer.IntegrationServices.Services.LdapConnectionService": "Debug"
          }
        },
  4. 保存文件。
  5. 回收 IIS 应用程序池中的 Authentication Server 池。

    如果您已从 4.3 之前的版本升级,则需要回收 IMS 池。

  6. 重新启动 IIS 站点中的 Authentication Server 站点。

这将在 Logs_AuthenticationServer 目录中创建一个文件,包含前缀“debug”和相应日期。

使用调试信息成功解决任何问题后,您必须删除已添加的行和逗号,保存文件并重复步骤 5 和 6。否则,日志文件的大小将显著增加,并可能占满内存。

日志收集器服务

此 Windows 服务从每个 Web 服务器组件(Hub、Interact、 Authentication Server、Audit Service、审核服务侦听器、Email Service、日志收集器服务、IADA、Interact Remote API、SignalR、Submit Form Manager)中移除旧产品日志。此服务安排在每月 7 日执行此操作,日志将移至 C:\Program Files (x86)\Blue Prism\ArchivedLogs。

您可以在 apppsettings.json 中更改存档日志文件夹路径和调度程序日期—C:\Program Files (x86)\Blue Prism\Log Service(默认)路径中的“ArchivedFolder”允许您更改存档路径,“DayOfMonth”允许您更改调度程序日期。

其他信息

以下链接可提供有用的其他信息: