阅读和查看 Automation Anywhere 文档

Automation Anywhere

关闭内容

内容

打开内容

日志记录

  • 已更新:5/10/2019
    • 11.3.x
    • 探索
    • Enterprise

日志记录

日志应该易于阅读和解析。

日志文件存储从各种应用程序和系统组件发出的消息。

日志应该易于阅读、理解和解析。确保日志文件的可读性、简洁性和描述性。显示正在处理的数据及其含义。显示机器人实际执行的操作。好的日志可以为机器人本身起到很好的记录作用。

日志可以帮助人员和计算机:

  • 确定流程是否已成功完成。
  • 在流程未完成的情况下,查看有关流程未完成的原因的信息。
  • 确定机器人是否按照预期执行。
  • 以交互方式跟踪日志。
  • 使用工具解析日志,或者将日志导入 Excel 以收集和分析指标。
  • 将日志导入数据库。

下面是一组可用于确保正确执行日志记录的标准。

日志类型

  • 流程/信息性 - 流程日志是用于提供信息的日志。它可用于监控任务的正常操作,但更重要的是,它可用于审核。使用流程日志进行审核跟踪是确定业务流程是否正确完成的绝佳方法。例如,订单是否已提交,或者票证是否已完成且没有错误。
  • 错误 - 错误日志用于提供详细的错误消息。当任务中发生错误时,应在流程日志中记录错误发生的通知。还应在错误日志中记录有关错误的详细信息。
  • 调试 - 在单独的日志文件中存储调试信息,并在实际正式模式下关闭调试收集。将机器人移动到实际正式环境中时,使用 isProductionMode 变量禁用这些语句。
  • 性能 - 性能日志记录可以放入流程/信息性日志或性能日志中。在某些情况下,将性能消息存储在单独的日志文件中很有用。

消息类型

  • ERROR - 发生了一些严重错误,必须立即进行调查。此时此任务无法正常执行其功能。例如:数据库不可用、任务关键型用例无法继续、文件繁忙且无法打开。
  • WARN - 任务可能会继续,但需要额外注意。例如:Task is running in development mode.任务可以继续运行,但需要始终验证并检查消息。
  • INFO - 重要的业务流程已经完成。信息消息(有时是加密的)说明有关应用程序的信息。例如:
    • 应用程序操作完成。对于机票预订应用程序,最佳情况是每张机票只发布一个 INFO 语句,并说明 [Who] booked ticket from [Where] to [Where]
    • 应用程序显著更改状态。Database updateExternal system request
  • DEBUG - 有助于调试机器人的任何信息,通常由机器人开发人员使用。这些消息不会放入流程日志。将机器人移动到实际正式环境中时,使用 isProductionMode 变量禁用这些语句。
  • PERFORMANCE - 性能日志记录可放入流程/信息性日志;如果已创建单独的性能日志,也可放入性能日志。性能日志跟踪执行特定步骤所使用的时间,但应避免粒度过细。在大多数情况下,应在整个业务流程中进行性能日志记录。例如,完成订单需要多长时间,或者处理发票需要多长时间。

创建日志的提示

  • 使用者

    日志文件有两种使用者:人和计算机。

    由人使用 - 在人是使用者时,其角色影响要查看的信息类型。开发人员可能需要信息来进行调试、分析性能或查找错误。分析人员可能需要审核信息或性能信息。

    由计算机使用 - 计算机通常通过由系统管理员编写的 Shell 脚本来读取日志文件。应设计适用于这两种日志文件使用者的日志。

  • 内容

    • 包括对象 - 好的日志包括:时间戳、日志记录级别、计算机名称、任务名称和消息。

    • 错误日志语句 - 包括来自 Automation Anywhere 错误处理块的任何错误的行号和错误描述。

    • 调试语句 - 在子任务之间传递变量时使用调试日志语句。在进入和退出子任务时包含变量值。在将机器人移动到实际正式环境中时,使用 isProductionMode 变量禁用调试语句。

    • 接口调用 - 如果一个机器人与其他系统(如元机器人、API、REST 或 SOAP 调用)相连接,记录这些调用及其响应(如果适用)。

  • 格式设置
    • 分隔符 - 分隔内容值。要支持简单的日志文件导入和解析,请使用制表符分隔方式来分隔值。

    • Log-to-file - 使用 Automation Anywhere 内置的 log-to-file 功能。

    • 时间戳 - 在 log to file 命令中使用内置时间戳。

      注: 即使是 Excel,也不要为时间戳创建自己的方法和格式。如果对不同时间戳有特定需求,只能从内置版本修改。
  • 安全和快捷方式
    • 密码 - 不要记录密码或任何个人信息!

    • 快捷方式 - 不要添加只有很少人能理解的快捷字符和脚本(幻码)。

    • 编号 - 避免数字格式设置。使用正则表达式可轻松识别的模式。

  • 性能

    • 过量日志记录 - 正常的日志记录命令本身不会占用太多性能。但是,不要允许过量的日志记录。例如,在小循环内执行多次迭代。

    • 频率 - 每 24 小时创建新日志。添加代码以检查当前日期。如果日期已更改,请创建新日志。根据需要压缩和存档(休眠)旧日志文件。这可以防止日志文件过大。

发送反馈