日志记录和日志级别

在执行流程的过程中，机器人会为整个过程的每一个步骤生成一则消息（日志）。这些消息会收集并存储在日志文件中。收集和存储日志的整体操作即称为日志记录。

每个日志都有日志级别，表示所生成消息的详细程度。

日志级别是指写入日志文件的严重性类型。

UiPath 中的日志记录级别

日志级别指所生成消息的详细程度。您可以通过以下方式进行配置：

• Assistant > 首选项 > 常规页面中的“日志级别”设置。 默认情况下，它设置为“信息”。

• “Orchestrator”>“管理访问权限”>“用户”>“用户或机器人帐户”>“机器人设置”页面中的“日志记录级别”设置。默认情况下，它设置为“信息”。

  备注：

  您在 Orchestrator 中设置的日志级别将覆盖在 Assistant 中配置的级别。

UiPath 使用以下日志级别，并按优先级升序排列。

• Off - 不存储任何日志。此级别通常用于关闭日志记录。
• Verbose - 报告更精细，记录有关自动化操作的每个可能的详细信息。这可能包括有关变量更改、函数调用甚至外部响应的信息。显示所有级别为 Trace 的日志。默认情况下，Verbose 级别包括以下日志条目：
  • 执行已开始 - 每当启动流程时生成。
  • 执行已结束 - 每当完成流程时生成。
  • 事务已开始 - 每当机器人从 Orchestrator 中获取事务项目时生成。
  • 事务已结束 - 每当机器人将事务状态设置为“成功”或“失败”时生成。
  • 活动信息 - 每当工作流中的活动启动、出现故障或完成时生成。
• Trace - 此类日志包含最详细的信息，通常用于调试或跟踪系统内特定任务的执行路径。显示级别为 Trace、Information、Warning、Error 和 Critical 的所有日志。
• Information - 信息日志提供有关自动化执行的一般见解，例如任务的开始和结束。显示级别为 Information、Warning、Error 和 Critical 的所有日志。
• Warning - 这些日志包含小问题或潜在问题，这些问题不会立即影响当前操作，但在将来可能会变得很重要。显示级别为 Warning、Error 和 Critical 的所有日志。
• Error - 在此级别生成的日志包括执行期间发生的错误的详细信息，这些错误会阻止正常的工作流操作，但不会导致整个系统停止。显示级别为 Error 和 Critical 的所有日志。
• Critical - 表明存在严重问题或错误的日志。严重到需要立即注意的问题通常会在此级别进行记录。

关于日志中的 PII 信息

Information、Warning、Error、 和 Critical

使用 Information、Warning、Error 和 Critical 日志级别时，不追踪输入/输出参数的值。这意味着在 Orchestrator 日志中不会发送任何 PII 信息，除非从 Studio 中显式添加。

Trace 与 Verbose

Trace 和 Verbose 日志级别在 Orchestrator 日志中跟踪和写入输入/输出参数的值。如果这些值包含 PII 信息，则这些值已添加到 Orchestrator 日志中。

使用 excludeLoggedData 隐藏敏感信息

excludedLoggedData 变量用于添加关键字，以防止在 Verbose 级别上记录变量和参数值。

这也可以通过选中任何活动的Private复选框来实现。 在此处阅读有关敏感信息保护的更多信息。

"excludedLoggedData": [
      "Private:*",
      "<em>password</em>"
    ],

日志类型：

根据所记录的事件，日志消息可能会出现如下所示的几种情况：

默认

以下情形中默认生成的日志：流程执行启动和结束，出现系统错误且执行停止，或者将日志记录设置配置为记录每个活动的执行。

备注：

在这些日志中，logType 字段的值为 Default。

此类别记录的事件包括：

• “执行开始”（每当启动流程时生成此事件）。从“Information”日志记录级别开始记录此事件。
• “执行结束”（每当完成流程时生成此事件）。从“Information”日志记录级别开始记录此事件。
• “事务开始”（每当启动流程中的事务时生成此事件）。从“Information”日志记录级别开始记录此事件。
• “事务结束”（每当完成流程中的事务时生成此事件）。从“Information”日志记录级别开始记录此事件。
• 错误日志（每当执行遇到错误并停止时生成此事件）。从“Error”日志记录级别开始记录此事件。
• 每当将“机器人日志记录设置”设为“Verbose”并包含活动名称、类型、变量值、参数等时，“调试日志”即会生成。从“Trace”日志记录级别开始记录此事件。

用户定义

当使用“日志消息”活动或“写入行”活动时，依据 Studio 中用户设计的流程生成的日志。

备注：

在这些日志中，logType 字段的值为 User。

日志字段

上述日志消息类型中包含多种类型的日志字段。具体可分成以下几类：

默认字段

• Message - The log message.
• Level - Defines the log severity.
• Timestamp - The exact date and time the action was performed.
• FileName - The name of the .xaml file being executed.
• 作业 ID *：运行流程的作业的键。
• 流程名称 *：触发日志记录的流程的名称。
• 流程版本 *：流程的版本号。
• windowsIdentity - The name of the user that performed the action that was logged.
• “机器人名称”*：机器人的名称（在 Orchestrator 中定义）。
• machineName - The name of the robot machine.
• 计算机 ID * - 机器人计算机的 ID。
• 组织单位 ID * - Orchestrator 组织的 ID。

无法使用“添加日志字段”活动覆盖标有星号的 * 日志字段。

备注：

如果您在本地运行流程，且未连接到 Orchestrator，则日志中不会出现 processName 和 processVersion 字段。

特定于类型的字段

这些日志会按日志类型显示：

执行结束

• 总执行时间（秒）
• 总执行时间

事务开始

• 队列名称
• 交易 ID
• 交易说明
• 初始化人员

事务结束

• 队列名称
• 交易 ID
• 交易说明
• 交易状态
• 事务执行时间
• 处理异常的类型
• 处理异常的原因
• 队列项目审核状态
• 队列项目优先级

调试日志

activityInfo，表示包含以下字段的 JSON 消息：

• 显示名称

• “状态”（故障、已关闭、正在执行）

• 活动

• 参数

  备注：

  只有 totalExecutionTimeInSeconds、totalExecutionTime 和 queueName 会一直出现在日志消息中。Variables 和 Arguments 通常有子字段。

用户定义的字段

通过使用“添加日志字段”活动，您即可在 Studio 中定义这些字段；除非通过“删除日志字段”活动将其删除，否则在生成活动后，所有后续日志中均会出现这些字段。

重要提示：

When defining Custom Log Fields make sure to also check the naming against the Default Log Fields to avoid conflicting information in the Log Files over the same Log Fields.

Having the same naming convention for both Custom and Default Log Fields can also impact the Process you are running.