插件 〉Business Text
Business Text
适用于 Grafana 的 Business Text
简介
Business Text 面板插件允许您根据数据源查询返回的数据集值构建文本可视化模板。
要求
- Business Text 面板 5.X 需要 Grafana 10 或 Grafana 11。
- Dynamic Text 面板 4.X 需要 Grafana 9.2 或 Grafana 10。
- Dynamic Text 面板 2.X 和 3.X 需要 Grafana 8.5 或 Grafana 9。
- Dynamic Text 面板 1.X 需要 Grafana 7。
入门
您可以从Grafana 插件目录安装 Business Text 面板,或使用 Grafana 命令行工具。
对于后者,请使用以下命令
grafana cli plugins install marcusolsson-dynamictext-panel
亮点
- 使用 Monaco 代码编辑器,支持 JavaScript 代码自动格式化。
- 支持Markdown 和Handlebars。
- 将markdown-it 渲染为 HTML 元素。
- 支持使用 A11Y 样式进行代码语法高亮显示。
- 提供代码净化
- 模板中的 HTML 使用XSS 进行净化。
- 可以通过 Grafana 配置中的
disable_sanitize_html
参数禁用。
- 支持使用
{{json object}}
Handlebars 助手显示嵌套对象。 - 支持将时间全局变量(
__to
和__from
)显示为秒、ISO 时间戳,或使用dayjs
库进行格式化。 - 支持添加 Handlebars 助手和事件处理器。
- 支持使用仪表盘变量添加 CSS 样式。
- 支持使用自定义助手进行国际化。
文档
章节 | 描述 |
---|---|
渲染 | 解释如何为您的数据创建可视化模板 |
技巧 | 可在模板中使用的实用片段 |
功能 | 演示面板功能和模板 |
教程 | 易于遵循的教程 |
发布说明 | 了解最新功能和更新 |
适用于 Grafana 的 Business 套件
Business 套件是由 Volkov Labs 创建并积极维护的开源插件集合。
该集合旨在通过提供直观的界面、详细的书面文档、示例和视频教程来解决最常见的业务任务。
企业支持
拥有 Business Suite Enterprise,您不仅获得产品,更获得一套完整的支持系统。您将拥有一支专门的支持团队,随时准备解决任何问题。
您可以通过 Zendesk 联系我们,获得功能请求和错误修复的优先处理,与我们进行面对面咨询,并访问商业智能功能。这是一套旨在让您工作更轻松的方案。
随时期待您的来信
- 在GitHub Issues 上提问、请求新功能或报告问题。
- 订阅我们的YouTube 频道并留下您的评论。
- 成为 Business 套件赞助商。
许可证
Apache 许可证 2.0 版,参见LICENSE。
在 Grafana Cloud 上安装 Business Text
在 Grafana Cloud 实例上安装插件只需一键完成;更新也一样。很酷,对吧?
请注意,插件可能需要长达 1 分钟才会出现在您的 Grafana 中。
在 Grafana Cloud 实例上安装插件只需一键完成;更新也一样。很酷,对吧?
请注意,插件可能需要长达 1 分钟才会出现在您的 Grafana 中。
在 Grafana Cloud 实例上安装插件只需一键完成;更新也一样。很酷,对吧?
请注意,插件可能需要长达 1 分钟才会出现在您的 Grafana 中。
在 Grafana Cloud 实例上安装插件只需一键完成;更新也一样。很酷,对吧?
请注意,插件可能需要长达 1 分钟才会出现在您的 Grafana 中。
在 Grafana Cloud 实例上安装插件只需一键完成;更新也一样。很酷,对吧?
请注意,插件可能需要长达 1 分钟才会出现在您的 Grafana 中。
在 Grafana Cloud 实例上安装插件只需一键完成;更新也一样。很酷,对吧?
请注意,插件可能需要长达 1 分钟才会出现在您的 Grafana 中。
在 Grafana Cloud 实例上安装插件只需一键完成;更新也一样。很酷,对吧?
请注意,插件可能需要长达 1 分钟才会出现在您的 Grafana 中。
更多信息,请访问关于插件安装的文档。
在本地 Grafana 上安装
对于本地实例,插件通过简单的 CLI 命令安装和更新。插件不会自动更新,但当有可用更新时,您将在 Grafana 中收到通知。
1. 安装面板
使用 grafana-cli 工具从命令行安装 Business Text
grafana-cli plugins install
插件将被安装到您的 grafana plugins 目录中;默认目录为 /var/lib/grafana/plugins。更多关于 cli 工具的信息。
2. 将面板添加到仪表盘
已安装的面板会立即显示在 Grafana 主菜单的仪表盘部分,并且可以像 Grafana 中的任何其他核心面板一样添加。
要查看已安装面板列表,请点击主菜单中的插件项。核心面板和已安装面板都将显示。
变更日志
5.7.0 (2025-03-05)
功能 / 增强
- 添加了 context.grafana.refresh (#387)
- 更新了外部资源使用 (#384)
- 更新至 Grafana 11.5 及依赖项 (#402)
- 更新了发布工作流程以包含证明 (#402)
5.6.0 (2024-12-15)
功能 / 增强
- 更新了代码编辑器包 (#380)
5.5.0 (2024-12-09)
功能 / 增强
- 更新了自动调整代码编辑器工具栏 (#362)
- 添加了来自特定字段的 helper statusColor (#375)
- 更新了 E2E 测试 (#377)
- 更新至 Grafana 11.4 及依赖项 (#378)
- 添加了在 URL 中替换变量的功能 (#376)
5.4.0 (2024-09-12)
功能 / 增强
- 更新了当第一个数据源没有数据时面板的渲染方式 (#353)
- 在代码编辑器中添加了换行按钮 (#359)
- 更新了局部加载 (#358)
- 更新了超链接样式 (#358)
5.3.0 (2024-08-22)
功能 / 增强
- 更新了配置仪表盘 (#346)
- 添加了局部加载外部 HTML 的功能 (#345)
- 添加了可展开编辑器 (#348)
5.2.0 (2024-07-25)
功能 / 增强
- 更新了助手迁移 (#338)
- 更新至 Grafana 11.1 及依赖项 (#339)
5.1.0 (2024-07-01)
功能 / 增强
- 更新了异步渲染前代码并传递 markdown 实例 (#322)
- 添加了在 docker 中运行 e2e 测试的功能 (#323)
- 更新了视频教程 (#330)
5.0.0 (2024-06-06)
重大变更
- 需要 Grafana 10 和 Grafana 11。
- 移除了在 Grafana 11 中已弃用的外部脚本。请改用 import。
- 移除了非上下文代码参数。请更新参数以使用 context。
代码参数迁移指南
- data -> context.data
- dataFrame -> context.dataFrame
- eventBus -> context.grafana.eventBus
- getLocale -> context.grafana.getLocale
- handlebars -> context.handlebars
- locationService -> context.grafana.locationService
- panelData -> context.panelData
- replaceVariables -> context.grafana.replaceVariables
- timeRange -> context.grafana.timeRange
- timezone -> context.grafana.timezone
功能 / 增强
- 添加了插件 e2e 测试并移除 cypress (#301)
- 名称更新为 Business Text 面板 (#304)
- 为 Grafana 11 做好准备 (#304)
- 添加了 ES6 模块支持 (#312)
- 在面板选项中添加了单位和小数 (#311)
- 更新至 Grafana 11.0 及依赖项 (#315)
4.5.0 (2024-03-13)
功能 / 增强
- 如果启用了净化功能,则添加信息消息 (#290)
- 更新了响应式 CSS 样式并支持主题 (#281)
- 更新至 Grafana 10.4.0 (#291)
4.4.0 (2024-03-06)
重大变更
- 需要 Grafana 9.2 和 Grafana 10
功能 / 增强
- 更新了 context 参数 (#270)
- 添加了主题对象、notifySuccess 和 notifyError (#270)
- 更新了依赖项和操作 (#271)
- 使用 Code Parameters Builder 替换自定义代码参数 (#285)
- 更新了面板而不是行的 CSS 类 (#272)
- 更新了编辑器的自动高度,不再是固定值 (#278)
- 禁用了 unitScale 和 fieldMinMax 标准面板选项 (#286)
Bug 修复
- 修复了行的 statusColor (#280)
4.3.0 (2023-12-25)
功能 / 增强
- 更新了 ESLint 配置并重构 (#239)
- 更新了来自 @volkovlabs/components 的 Collapse (#239)
- 更新了 README 中的介绍视频 (#240)
- 添加了数据渲染模式并传递选定的数据帧 (#246)
- 更新至 Grafana 10.2.2 和 Volkov labs 包 (#247)
- 添加了 variableValue 助手 (#252)
- 在仪表盘刷新时添加重新渲染功能 (#252)
Bug 修复
- 修复了 Grafana 10.3 中的可拖动图标 (#249)
4.2.0 (2023-11-20)
功能 / 增强
- 添加了 ESLint 弃用检查 (#203)
- 添加了在内容准备就绪后调用的自定义代码选项 (#231)
- 添加了启用/禁用换行选项以支持 HTML 中的空行 (#235)
- 添加了 handlebars 助手 (startsWith, endsWith, match) (#211)
- 更新了 ESLint 配置并排序 imports (#236)
- 更新至 Plugin Tools 2.1.1 (#236)
- 使用 Grafana Access Policy 签名插件 (#236)
- 更新至 Grafana 10.2.1 (#237)
4.1.0 (2023-07-16)
功能 / 增强
- 更新了 ESLint 配置 (#192)
- 提高了测试覆盖率 (#194)
- 添加了 status 字段 (#196)
- 添加了外部 JavaScript、CSS 资源 (#197)
- 更新至 Grafana 10.0.2 依赖项 (#201)
4.0.0 (2023-06-26)
重大变更
- 需要 Grafana 9 和 Grafana 10
功能 / 增强
- 提高了测试覆盖率并更新至 testing-library/react (#177)
- 将 Event Bus 对象添加到 JavaScript 函数 (#179)
- 迁移至 Plugin Tools 1.5.2 (#183)
- 更新至 Grafana 10.0.0 (#166, #178, #183)
- 更新至 Node 18 和 npm (#183)
- 移除 Grafana 8.5 支持 (#183)
- 添加了 E2E Cypress 测试 (#184)
- 在 CSS 样式编辑器中支持变量 (#185)
3.1.0 (2023-03-12)
功能 / 增强
- 为 Javascript 代码添加了时区和范围参数 (#155)
- 更新至 Grafana 9.4.3 (#156)
- 在 README 中添加了 Magic (JavaScript) Trio 教程 (#157)
- 使用作用域函数更新替换变量 (#160)
- 为 Javascript 代码添加了替换变量和位置服务参数 (#160)
3.0.0 (2023-02-19)
重大变更
除非值被修改,否则默认不显示默认内容和 JavaScript 编辑器。要显示所需的编辑器,包括新的样式,应在列表中选择它们。
功能 / 增强
- 使用新的 JavaScript 代码编辑器更新了 README 功能介绍 (#141)
- 更新至 Grafana 9.3.6 (#147)
- 更新了 CI 和发布工作流程 (#147)
- 更新了 README 以包含 JavaScript 教程 (#148)
- 添加了自定义样式 (#149)
- 添加了显示可选编辑器的选项 (#149)
- 移除了面板填充 (#150)
- 添加了代码语法高亮显示 (#151)
- 添加了显示可选编辑器的重大变更说明 (#152)
2.2.0 (2023-01-09)
功能 / 增强
- 添加了显示对象和数组的 JSON 助手 (#121)
- 更新至 Grafana 9.3.1 (#122)
- 更新了文档链接 (#130, #131)
- 添加了 Split 助手 (#132)
- 重构了 Text 组件和样式 (#133)
- 添加了用于添加 Handlebars 助手和事件处理器的 JavaScript 代码 (#134)
- 更新了默认内容为
{{json @root}}
,代码编辑器高度为 200px (#134) - 更新了 CSS 以使图像适应屏幕 (#135)
- 为 JavaScript 代码添加了
getLocale()
参数 (#137)
2.1.0 (2022-11-27)
重大变更
重构可能会引入重大变更。在生产环境升级之前请进行测试。
功能 / 增强
- 修复了 README 中的损坏链接 (#111)
- 更新了 CI 以上传签名工件 (#113)
- 添加了解析时间格式化语法的功能 (#86)
- 修复了使用转换时的数据渲染问题 (#98)
- 将面板选项更新为 Monaco 代码编辑器 (#114)
- 提高了测试覆盖率 (#114)
- 重构并更新了图像 (#116)
- 重构了告警消息和文本选项 (#117)
- 添加了禁用净化 HTML 配置的支持 (#118)
2.0.0 (2022-11-02)
重大变更
此版本将最低所需的 Grafana 版本提高到 >=8.5。
功能 / 增强
- 由 Volkov Labs 维护 (#100)
- 基于 Volkov Labs 面板模板更新 (#100)
- 更新至 Grafana 9.1.6 (#104)
- 在 README 中添加了“适用于 Grafana 的 Dynamic Text 插件”视频 (#106)
- 更新 CI 至 Node 16 并与发布工作流程同步 (#107)
- 更新至 Grafana 9.2.2 (#108)
- 更新了截图和配置 (#109)
1.9.0 (2022-01-09)
功能 / 增强
- 添加了一个选项,可为每一行或作为单个模板渲染模板。当您想从查询结果创建表格时非常有用。(#53) 感谢 @andykingking。
Bug 修复
- 由于溢出,选择多个帧的下拉菜单不可见。(#65)
1.8.0 (2021-11-19)
功能 / 增强
- 添加了 contains 助手 (#48)
- 升级依赖项
1.7.2 (2021-06-21)
功能 / 增强
- 改进了错误处理。避免在模板错误时刷新仪表盘。
1.7.1 (2021-06-15)
功能 / 增强
- 更新了文档和元数据
- 升级依赖项
1.7.0 (2021-03-08)
功能 / 增强
- 添加了空查询结果默认内容的选项 (#15)
1.6.0 (2021-03-04)
功能 / 增强
- 改进了错误处理
1.5.0 (2021-02-16)
功能 / 增强
- 避免在每次渲染时重新编译模板
1.4.0 (2021-01-08)
功能 / 增强
- 更新了 @grafana/* 包
- 改进了表格和引用块的样式
1.3.0 (2021-01-08)
功能 / 增强
- 支持在模板中使用 HTML 标签 (#4)
- 添加了额外的条件运算符 (#3)
1.2.1 (2020-11-27)
功能 / 增强
- 将 @grafana 依赖项从 ^7.0.0 更新到 ^7.3.0
- 使用新的 Grafana 插件 GitHub 工作流程改进了发布流程
- 添加截图