订阅

UiPath 机器人

UiPath 机器人指南

日志记录和日志级别

描述

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

每个日志都有日志级别,表示所生成消息的详细程度。
日志级别是指写入日志文件的严重性类型。

640

UiPath 中的日志记录级别

Log LevelLoggedExample / CommentLog FileOutput PanelOrchestrator Log page
VerboseActivitiesTrace {"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"}
YesNoYes
VerboseVariables"Variables":{"NewTransaction":"False"}}YesNoYes
VerboseArguments (properties)"Arguments":{"Caption":"","Text":"String in message BOX","ChosenButton":"Ok"}YesNoYes
TraceActivitiesTrace {"message":{"DisplayName":"Main","State":"Executing","Activity":"System.Activities.DynamicActivity"}
Trace {"message":{"DisplayName":"Main","State":"Executing","Activity":"System.Activities.Statements.Flowchart"}
YesNoYes
TraceWriteLineTrace {"message":"write","level":"Trace","logType":"User","timeStamp":"","fingerprint":"","windowsIdentity":"","machineName":"","processName":"New Process","processVersion":"","jobId":"","robotName":"","machineId":,"organizationUnitId":}YesYesYes
InformationLog MessageInfo {"message":"message from activity"
Note: Except messages logged with Trace level set in activity.
WarningWarningsWarn {"message":"Warning from log message activity"YesYesYes
WarningErrorsError {"message":"Error from log message activity"YesYesYes
WarningCriticalCritical ErrorsYesYesYes
ErrorErrorsError {"message":"Error from log message activity"YesYesYes
ErrorCritical
Fatal
Critical ErrorsYesYesYes
CriticalCritical
Fatal
Critical ErrorsYesYesYes
OFFn/an/aNoNoNo

UiPath 中的日志记录级别

Logging LevelDefault LogsUser-Defined Logs
OffNoneNone
CriticalAll messages logged with Critical level or higher.All messages logged with Critical level or higher.
ErrorAll messages logged with Error level or higher.All messages logged with Error level or higher.
WarningAll messages logged with Warning or higher.All messages logged with Warning or higher.
InformationAll messages logged with Information or higher.All messages logged with Information or higher.
TraceAll messages logged with Trace level or higher.All messages logged with Trace level or higher.
VerboseAll messages logged with Trace level and Workflow Tracking logs.All messages logged with Trace level.

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

默认情况下,“Verbose”级别包括:

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

📘

备注:

日志类型的优先级顺序为:Verbose < Trace < Information < Warning < Error < Critical < Off

关于日志中的 PII 信息

InformationWarningErrorCritical

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

TraceVerbose

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

使用 excludeLoggedData 隐藏敏感信息

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

That can also be achieved by selecting the Private checkbox of any activity. Read more about the protection of sensitive information here.

"excludedLoggedData": [
      "Private:*",
      "*password*"
    ],

日志类型:

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

默认

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

📘

备注:

在这些日志中,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。

* Log fields marked with an asterisk cannot be overridden using the Add Log Fields activity.

📘

备注:

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

特定于类型的字段

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

执行结束

  • totalExecutionTimeInSeconds
  • 总执行时间

事务开始

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

事务结束

  • 队列名称
  • 交易 ID
  • 交易说明
  • 交易状态
  • transactionExecutionTime
  • processingExceptionType
  • processingExceptionReason
  • queueItemReviewStatus
  • 队列项目优先级

调试日志

activityInfo,表示包含以下字段的 JSON 消息:

  • DisplayName
  • “状态”(故障、已关闭、正在执行)
  • 活动
  • 参数

📘

备注:

只有 totalExecutionTimeInSecondstotalExecutionTimequeueName 会一直出现在日志消息中。VariablesArguments 通常有子字段。

用户定义的字段

These fields are defined in Studio by using the Add Log Fields activity and appear in all subsequent logs after the activity is generated, unless they are removed by the Remove Log Fields activity.

🚧

重要

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.

4 个月前更新


另请参阅

机器人日志

日志记录和日志级别


建议的编辑仅限用于 API 参考页面

您只能建议对 Markdown 正文内容进行编辑,而不能建议对 API 规范进行编辑。