机器人用户指南

上次更新日期 2024年12月18日

日志记录和日志级别

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

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

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

UiPath^TM 中的日志记录级别

日志级别	日志内容	示例/注释	日志文件	输出面板	Orchestrator 日志页面
详情	活动	Trace {"message":{"DisplayName":"Message box","State":"Executing","Activity":"UiPath.Dialog.Activities.MessageBox","Arguments":{"Caption":"","Text":"String in message BOX"}... Trace {"message":{"DisplayName":"Message box","State":"Closed","Activity":"UiPath.Dialog.Activities.MessageBox","Arguments":{"Caption":"","Text":"String in message BOX","ChosenButton":"Ok"}	是	否	是
详情	变量	"Variables":{"NewTransaction":"False"}}	是	否	是
详情	参数（属性）	"Arguments":{"Caption":"","Text":"String in message BOX","ChosenButton":"Ok"}	是	否	是
追踪	活动	Trace {"message":"write","level":"Trace","logType":"User","timeStamp":"","fingerprint":"","windowsIdentity":"","machineName":"","processName":"New Process","processVersion":"","jobId":"","robotName":"","machineId":,"organizationUnitId":}	是	否	是
追踪	写入行	Trace {"message":{"DisplayName":"Main","State":"Executing","Activity":"System.Activities.DynamicActivity"} Trace {"message":{"DisplayName":"Main","State":"Executing","Activity":"System.Activities.Statements.Flowchart"}	是	是	是
信息	日志消息	Info {"message":"message from activity" 注意：不包括在活动中设置为“Trace”级别的日志消息。
Warning	警告	警告 {"message":"来自日志消息活动的警告"	是	是	是
Warning	错误	错误 {"message":"来自日志消息活动的错误"	是	是	是
Warning	重要事项	严重错误	是	是	是
错误	错误	错误 {"message":"来自日志消息活动的错误"	是	是	是
错误	CriticalFatal	严重错误	是	是	是
重要事项	CriticalFatal	严重错误	是	是	是
关闭	不适用	不适用	否	否	否

UiPath^TM 中的日志记录级别

日志记录级别	默认日志	用户定义的日志
关闭	无	无
重要事项	所有“Critical”或更高级别的日志记录消息。	所有“Critical”或更高级别的日志记录消息。
错误	所有“Error”或更高级别的日志记录消息。	所有“Error”或更高级别的日志记录消息。
Warning	所有“Warning”或更高级别的日志记录消息。	所有“Warning”或更高级别的日志记录消息。
信息	所有“Information”或更高级别的日志记录消息。	所有“Information”或更高级别的日志记录消息。
追踪	所有“Trace”或更高级别的日志记录消息。	所有“Trace”或更高级别的日志记录消息。
详情	所有“Trace”级别和工作流追踪日志的记录消息。	以 Trace 级别记录的所有消息。

“Verbose”级别记录“开始”和“结束”活动的消息，以及所使用的变量和参数值。

默认情况下，“Verbose”级别包括：

“执行已开始”日志条目 - 每当启动流程时生成此条目。
“执行已结束”日志条目 - 每当完成流程时生成此条目。
“事务已开始”日志条目 - 每当机器人从 Orchestrator 中获取事务项目时生成此条目。
“事务已结束”日志条目 - 每当机器人将事务状态设置为“成功”或“失败”时生成此条目。
“活动信息”日志条目 - 每当工作流中的活动“启动”、“出错”或“结束”时生成此条目。

注意：日志类型的优先级顺序为：Verbose < Trace < Information < Warning < Error < Critical < Off。

关于日志中的 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>"
    ],"excludedLoggedData": [
      "Private:*",
      "<em>password</em>"
    ],

日志类型：

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

默认

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

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

此类别记录的事件包括：

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

用户定义

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

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

日志字段

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

默认字段

消息：日志消息。
级别：定义日志严重性。
时间戳：执行操作的确切日期和时间。
文件名：正在执行的 .xaml 文件的名称。
作业 ID *：运行流程的作业的键。
流程名称 *：触发日志记录的流程的名称。
流程版本 *：流程的版本号。
窗口身份：执行所记录操作的用户的名称。
机器人名称*：机器人的名称（在 Orchestrator 中定义）。
machineName - 机器人计算机的名称。
计算机 ID * - 机器人计算机的 ID。
组织单位 ID * - Orchestrator 组织的 ID。

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

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

特定于类型的字段

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

执行结束

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

事务开始

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

事务结束

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

调试日志

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

显示名称
“状态”（故障、已关闭、正在执行）
活动
参数

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