核心概念
Trendz Metric Explorer 支持基于现有遥测创建新指标。以下介绍指标创建的完整流程。
指标定义
指标定义是对未来指标的描述,包括以下内容:
- 指标名称 — 在字段选项卡(已生成指标文件夹)中显示的名称
- 指标描述 — 简要说明该指标的作用
- 计算方式 — 说明如何计算该指标的步骤指引
指标定义本身不含具体实现代码,仅为规划方案和实现指引,相当于待实现指标的蓝图。
已生成指标
已生成指标是指标定义的具体实现,包含可执行的 Python 代码。该代码用于计算并展示遥测数据(可在图表或数值表中查看)。需要注意的是,已生成指标本身不代表 ThingsBoard 中的实际数据点,而是实时计算出的数值。同时,已生成指标不能直接用于 Trendz 生态中,它仅作为未来创建 ThingsBoard 遥测的模板。
原生字段计算
每个指标均可转换为原生字段计算。该字段包含已集成到 Trendz 生态中的指标代码。在此阶段,ThingsBoard 中仍无数据点存储,但可以将该字段计算用作实时字段计算。
有关原生字段计算的详细说明,请参阅此处。
带遥测点的原生字段计算
要将遥测数据保存至 ThingsBoard,需为原生字段计算配置重新处理任务或刷新任务。关于将指标遥测保存至 ThingsBoard 的详细流程,请参阅此处。
创建新指标
创建新指标需按如下步骤操作:
- 选择要生成指标的业务实体
- 从该实体下选择用于测试指标的具体实体
- 选择执行指标测试的时间范围
- 点击+ 新增指标
将看到两种选项:
AI 建议
AI 会根据您的遥测和拓扑建议六种不同的指标。点击任意指标可查看其定义(名称、描述、计算方式)及应用场景。
若对 AI 生成的指标不满意,可点击 刷新建议 重新生成建议。
若认可某个指标,点击 实现字段,随后将跳转到 已生成指标概览 选项卡。该选项卡的功能将在后文详细说明。
重要提示: 若未启用 AI 功能 指标代码助手,AI 建议将被禁用。 启用方法详见此处。
手动创建
此选项允许您手动创建任意指标,可以选择使用或不使用 AI 辅助。要切换到此模式,点击手动创建按钮。
不使用 AI 生成时:仅需填写字段名称,该名称将显示在已生成指标文件夹中。
使用 AI 生成时:勾选使用 AI 创建指标,然后填写以下字段:
- 描述与计算逻辑 — 说明该字段的用途及实现方式
- 使用关联 — 若选择是,代码将能访问关联实体的遥测数据
填写完成后,点击创建自定义字段,将跳转到包含 AI 生成代码的概览页面。相关功能说明将在下一节介绍。
重要提示: 若未启用 AI 功能 指标代码助手,使用 AI 生成将被禁用。
已生成指标操作
可通过以下方式访问已生成指标概览:
- 点击已生成指标部分中的任意指标
- 使用本文档「创建新指标」部分的方法实现指标
若未使用 AI 生成指标,将看到空白代码编辑器;若使用 AI,则会显示 AI 生成的代码。
代码编辑器
在代码编辑器中可编写或修改指标代码,语法与原生字段计算相同。详见此处。
修改代码后,可点击保存更改保存,或点击取消更改撤销修改。
若代码存在问题,问题所在行旁边会显示红色叉号。
测试代码
要测试代码,点击运行测试按钮。系统将跳转到图表页面,展示指标代码为所选实体生成的数据点。与指标概览中的图表逻辑相同。更多说明见此处。
查看日志
要查看日志,点击屏幕左上角的日志按钮。
查看详情
要查看创建此指标所用的指标定义,点击指标详情按钮。
AI 助手
要与 AI 助手交互,点击询问 AI 按钮。您可以:
- 与 AI 讨论代码相关问题
- 请求 AI 重写或重构代码
- 请求 AI 检测并修复代码错误
在聊天界面中的具体操作如下:
发送新消息:
- 在文本框中输入新消息
- 查看 AI 修改后新生成的代码
查看历史消息对应的代码:
- 点击历史消息
- 查看该消息对应的 AI 生成代码
编辑历史消息并重新生成代码:
- 点击消息旁的编辑按钮
- 修改文本并确认更新
- 查看应用修改后的新生成代码
清除聊天历史:
- 点击清除历史按钮
- 点击清除以确认操作
重要提示: 仅当 AI 功能指标代码助手已启用时,AI 助手才可用。启用方法详见此处。
创建字段计算
可将指标保存为原生字段计算,从而在 Trendz 和 ThingsBoard 中使用。操作步骤如下:
- 点击保存计算
- 输入计算名称(在 Trendz 中显示)和计算键(在 ThingsBoard 中显示)
- 点击保存
此时字段计算已保存至 Trendz,但 ThingsBoard 中尚无遥测数据。
系统也可能提示运行重新处理任务以将数据保存至 ThingsBoard:
- 点击运行按钮开始处理
- 选择重新处理的时间范围(即要保存至 ThingsBoard 的数据时段)
- 选择要包含在保存操作中的项(可选当前项、全部项或部分项)
- 点击运行开始任务
- 等待重新处理任务完成(运行期间可浏览其他指标)
重新处理任务完成后,遥测数据将保存至 ThingsBoard。
关于将遥测保存至 ThingsBoard 的详细说明,请参阅此指南。
管理关联字段计算
若指标有关联字段计算,可点击打开计算按钮将其打开。
若关联字段计算的代码已修改,会看到警告字段计算与指标未同步。若指标本身已更改,会看到警告字段计算已过时,需要更新。
要更新关联字段计算或创建新字段:
- 点击保存计算按钮
- 选择更新现有计算并点击保存,以更新关联字段计算
- 选择创建新计算并点击保存,以创建新的字段计算
若选择创建新计算,指标将与新创建的字段计算关联。
其他操作
重命名指标:
- 点击指标名称旁的更改名称按钮
- 输入新名称
- 点击保存
删除指标:
- 点击指标名称旁的删除按钮
- 再次点击删除确认
选项卡部分
仅当已生成指标具有对应的原生字段计算,且 ThingsBoard 中在所选时间范围内存在该遥测数据时,才能查看统计、时间模式和范围分析选项卡。
若所选指标尚未创建原生字段计算,系统会提示从该指标创建一个字段计算。
若所选指标已创建原生计算但在选定时间范围内无数据点,系统会提示运行重新处理任务以将数据保存至 ThingsBoard。
遥测保存至 ThingsBoard 后,可在各选项卡查看生成的数据。
有关这些选项卡的详细说明,请参阅此处。
关于将遥测保存至 ThingsBoard 的详细说明,请参阅此指南。
最佳实践
- 如需创建特定指标,在手动模式下使用 AI 生成。
- 若生成的代码无法运行:检查日志,验证关联关系是否正确。
- 若生成的代码因超时而失败:可增大 Python Executor 的超时时间,或检查
get_telemetries的调用方式。若在循环中调用,可请 AI 改为每台设备仅调用一次以提升性能;也可缩短时间范围以减少需要分析的数据点数量。 - 向 AI 提供清晰的指示,避免只说「修复我的代码」,而应指出具体的错误原因或需求。
- 定期使用保存按钮保存工作,避免意外丢失。
- 可请 AI 在代码中添加更多注释以解释各部分功能,或删除不必要的注释以提高可读性。也可请 AI 增加日志输出,便于在日志区进行调试。
下一步
-
快速入门指南 - 快速了解 Trendz 主要功能。
-
安装指南 - 学习在各种操作系统上部署 Trendz。
-
异常检测 - 学习识别数据中的异常。
-
字段计算 - 了解字段计算及使用方法。
-
状态 - 学习基于原始遥测定义和分析资产状态。
-
预测 - 学习进行预测及遥测行为预测。
-
筛选器 - 学习在分析中筛选数据集。
-
可用可视化部件 - 了解 Trendz 中可用的可视化部件及配置方法。
-
分享与嵌入可视化 - 学习将 Trendz 可视化添加到 ThingsBoard 仪表盘或第三方网页。
-
AI 助手 - 学习使用 Trendz AI 功能。