监视和故障排除 Dataverse 插件运行(预览版)

[本主题是预发行文档,有可能会有所更改。]

使用跟踪对低代码插件和专业代码插件进行故障排除。跟踪有助于制作者通过记录运行时信息来帮助诊断失败原因,或在开发期间对某些状态进行常规验证。

重要提示

  • 这是一项预览功能。
  • 预览功能不适合生产使用且功能可能受限。 这些功能在正式发布之前已经可用,以便客户可以抢先体验并提供反馈。

Dataverse 加速器的插件监视模块是 Microsoft Dataverse 插件中可用的现有跟踪和记录功能的增强视图。该界面有助于通过结合使用相关详细信息来在开发阶段改进故障排除和调试流程。

可按以下工作流类型在 24 小时内从跟踪表中读取应用中显示的所有事件:

  • 插件
  • 自定义 API
  • 即时和自动化低代码插件

插件监视界面

先决条件

您必须拥有以下安全角色分配和对 Dataverse 加速器应用的访问权限。

  • 安全角色:默认情况下,系统定制员和系统管理员安全角色都具有启用日志和使用应用所需的必要特权。

  • 或者,您也可以通过配置以下特权,创建对每种功能具有特定访问权限的自定义角色:

    • 若要读取日志,需要对跟踪表具有组织级别读取特权。
    • 要在环境中启用日志记录,需要在组织表的PluginTraceLogSetting中拥有组织级写入权限。

主要功能

  • 集中式日志查看器:从一个集中位置访问和查看环境中 Dataverse 自定义 API、低代码插件和专业代码插件执行中的跟踪日志。
  • 筛选功能:轻松筛选日志历史记录,以便快速查找与调试需求相关的日志。

安装

此功能在 Dataverse 加速器应用中可用。 有关安装说明,请转到 Dataverse 加速器文章

试用插件监视功能

  1. 播放 Dataverse 加速器

  2. 转到插件监视功能(在左侧导航窗格上或登陆屏幕的功能卡片上)。

导航到插件监视页面

启用日志捕获

如果您的环境中未启用日志捕获,登陆页面将显示关闭状态,带有两个用于启用记录的选项:全部异常。 根据您的需求选择适当的选项,请转到记录和跟踪文章以获取详细信息。

使用按钮启用记录屏幕以启用所有日志或仅启用异常

如果需要,您可以稍后在设置屏幕上更改这些设置,可在主屏幕的命令栏上进行访问。

日志设置屏幕提供用于更新日志设置的控件

小费

跟踪和记录非常适合在插件开发期间进行调试。 对于生产中的插件工作流,请使用 Azure App Insights 进行监视

查看日志

启用日志后,插件事件开始显示在屏幕上显示的主列表中。

小费

如果没有显示日志,您可以创建和运行新的低代码插件以开始显示日志。

筛选日志

利用筛选功能快速查找与正在处理的插件相关的日志。

选择命令栏右上角的筛选器以打开筛选器窗格。 您也可以使用搜索栏,按关键字快速进行筛选。

筛选日志

筛选器 Description
客户 选择插件的逻辑名称。
之后/之前启动 调用插件的日期和时间。
仅启用异常 显示具有失败状态的运行。
最小/最大持续时间 插件持续时间的最小值和最大值范围。
类型​​ 插件工作流的分类。 可用类型包括:
  • 即时低代码插件
  • 自动化低代码插件
  • 插件
  • 自定义 API
模式 插件是同步还是异步。

读取日志详细信息

选择特定日志条目以查看有关插件执行的详细信息。 日志详细信息包括时间戳、插件名称、执行状态、输出参数、错误消息等。 消息块和异常块字段显示在窗格中的基本详细信息下面,如果相应列中存在数据,则展开。

最佳做法

检查日志详细信息

  • 选择特定日志条目以查看有关插件执行的详细信息。
  • 日志详细信息可能包括时间戳、插件名称、执行状态、输入/输出参数、错误消息等。

解决问题

  • 使用跟踪日志中提供的信息对在插件执行期间出现的任何问题进行故障排除。
  • 分析错误消息、输入/输出参数和执行详细信息,以确定问题的根本原因。
  • 使用跟踪消息提供有用的提示。 写入跟踪服务在 Dataverse SDK 和低代码插件中作为 Power Fx 中的 Trace 函数 可用。

执行操作

  • 根据从跟踪日志中收集到的见解,采取相应操作以解决识别到的任何性能问题或错误。
  • 这可能涉及调整插件配置、更新代码逻辑或寻求支持资源的帮助。

计划测试

  • 养成一种习惯,即计划可在跟踪日志中执行的测试案例,以在开发期间验证插件性能。
  • 及时解决任何问题或异常,以维护 Dataverse 插件的整体稳定性和可靠性。

监视插件性能

  • 通过查看使用 Application Insights 注册的跟踪日志,在生产中定期监视插件性能。
  • 密切注意执行状态、错误消息以及可能指示性能问题或错误的任何异常。

常见问题解答

需要什么特权才能访问跟踪日志查看器?

您必须至少具有对跟踪表的读取特权才能查看日志。

谁可以在环境中启用日志捕获?

具有适当安全角色的系统管理员可以在其环境中启用日志捕获。 特别是,需要对组织表的写入访问权限,才能更新 PluginTraceLogSetting 列值。

我是否可以筛选日志历史记录以查找特定日志?

是,跟踪日志查看器提供筛选功能,允许用户轻松查找与调试需求相关的日志。

插件监视功能是否在所有环境中可用?

该功能通过 Dataverse 加速器提供,并在安装了该应用的所有环境中可用。 该应用会自动安装在所有新环境中,但也可以按照安装说明安装在较旧环境中。

启用记录后,它仍显示“记录处于关闭状态”屏幕

如果您具有正确特权并且确定已启用记录,请刷新浏览器选项卡。您可以使用旧体验来验证是否已启用记录

另请参见

使用 Dataverse 加速器提前获取预览功能(预览版)