创建和管理报告
注意:正在寻找预构建的 Grafana 仪表盘? 查看我们完整的仪表盘库以及更多内容 →
报告功能允许您从任何仪表盘发送自动化和预定电子邮件。您可以配置这些报告的几个元素,并生成 PDF、CSV 文件和嵌入式图像。您对报告中使用的仪表盘所做的任何更改都会在下次发送报告时反映出来。
要求
对于 Grafana Enterprise,报告功能有以下要求
- 必须配置 SMTP 才能发送报告。更多信息请参阅SMTP 配置文档。
- 必须安装 Grafana 图像渲染插件 (v3.10+) 或设置远程渲染服务。更多信息请参阅图像渲染。
渲染配置
默认情况下,大于 10 MB 的附件(PDF、CSV 文件和嵌入式图像)不会发送,这可以防止邮件服务器拒绝电子邮件。您可以在报告配置中增加或减少此限制。
生成报告文件时,会将其临时写入 Grafana data
文件夹中相应的文件夹(csv
、pdf
、png
)。后台任务每 10 分钟运行一次,并删除临时文件。您可以通过配置 ini 文件中的 temp_data_lifetime
设置来设置文件在被删除之前应该存储多长时间。
访问控制
默认情况下,只有组织管理员可以创建报告。您可以使用基于角色的访问控制 (RBAC) 自定义谁可以创建报告。
启用RBAC 时,您需要具有相关权限才能创建和管理报告。请参阅特定指南以了解所需的权限。
创建报告
报告创建过程是多步骤的,但您无需按顺序完成这些步骤,您可以通过单击页面顶部的步骤名称来跳过步骤。
您也可以在过程中的任何步骤将报告保存为草稿
要创建报告,请按照以下步骤操作
- 在主菜单中,点击仪表盘 > 报告。
- 点击+ 创建新报告。
- 根据需要完成报告步骤
- 点击屏幕右上角的以下按钮之一
- 立即发送或安排发送 - 报告将按照您设置的计划发送。
- 保存为草稿 - 您可以在报告创建或更新过程中的任何时候保存草稿,即使缺少必填字段。报告在草稿状态下不会按照其计划发送。
- 放弃 - 删除报告草稿。此操作无法撤消。
1. 选择仪表盘
在此步骤中,选择报告基于的一个或多个仪表盘,以及这些仪表盘的变量和时间范围。选项如下
选项 | 描述 |
---|---|
源仪表盘(必填) | 选择要生成报告的仪表盘。 |
模板变量 | 选择所选仪表盘的变量值。仅当仪表盘具有变量时,才会显示此选项。 |
时间范围 | 如果将此字段留空,报告将使用仪表盘保存的时间范围。您可以选择更改报告的时间范围。 |
添加另一个仪表盘 | 向报告添加更多仪表盘。 |
模板变量
仅当仪表盘具有变量时,才会显示此选项。
您可以在报告页面上为仪表盘配置报告特定的模板变量。您选择的变量会覆盖仪表盘中的变量。有关使用模板变量的详细信息,请参阅变量。
报告中保存的查询变量可能会随着查询结果的变化而过时。例如,如果您的模板变量查询主机名列表,并且添加了新的主机名,则该主机名将不会包含在报告中。如果发生这种情况,必须在报告中手动更新选定的变量。如果为模板变量选择全部值,或者保留仪表盘的原始变量选择,则报告会随着新值的添加而保持最新。
时间范围
如果将时间范围字段留空,报告将使用仪表盘保存的时间范围。您可以选择通过在时间范围字段中设置来更改报告的时间范围。如果指定,自定义时间范围会覆盖报告仪表盘的时间范围。
报告的页面标题会显示仪表盘数据查询的时间范围。
报告时区
报告使用生成它们的仪表盘的时区。您可以通过将仪表盘设置为特定时区来控制报告的时区。请注意,这会影响所有用户的仪表盘显示。
如果仪表盘设置为浏览器时间,则从该仪表盘生成的报告将使用 Grafana 服务器的时区。因此,此时间区可能与创建或接收报告的用户的时区不匹配。如果您想使用特定时区,请将仪表盘保存为固定时区,而不是浏览器时间
每个仪表盘的时区设置在时间范围控件中可见。
2. 格式化报告
在此步骤中,选择一个或多个报告格式选项。您可以选择多个选项,但必须选择_至少一个_
将报告作为 PDF 附件发送
如果在样式化 PDF 部分下选择了 PDF 格式选项,您可以配置以下选项
配置多个 PDF - 如果您想为报告中包含的所有仪表盘生成一个 PDF 文件,请选中将所有仪表盘 PDF 合并到一个文件中复选框。此选项仅当您的报告包含多个仪表盘时才显示。
配置报告标题 - 选中显示模板变量复选框以显示仪表盘变量。
方向 - 在纵向或横向中设置报告方向。请参阅布局和方向表以查看示例。
布局 - 选择以下选项之一
简单 - 将每个面板渲染为 PDF 的全宽。
网格 - 以与源仪表盘相同的面板排列和宽度渲染 PDF。
请参阅布局和方向表以查看示例。
缩放 - 放大以放大 PDF 中的文本,或缩小以查看每个面板中更多的数据(例如表格列)。
点击屏幕右上角的预览 PDF以使用您选择的选项查看渲染的 PDF。
布局和方向
布局 | 方向 | 描述 | 预览 |
---|---|---|---|
简单 | 纵向 | 生成一个 A4 纵向页面,每页包含三个面板。 | ![]() |
简单 | 横向 | 生成一个 A4 横向页面,每页包含一个面板。 | ![]() |
网格 | 纵向 | 生成一个 A4 纵向页面,面板的排列方式与原始仪表盘相同。 | ![]() |
网格 | 横向 | 生成一个 A4 横向页面,面板的排列方式与原始仪表盘相同。 | ![]() |
在电子邮件中嵌入仪表盘图像
您可以发送一封带有仪表盘图像嵌入在邮件中的报告电子邮件。这使得电子邮件收件人可以一目了然地看到仪表盘。
将表格面板数据的 CSV 文件作为附件发送
您可以为所选仪表盘上的每个表格面板将 CSV 文件附加到报告电子邮件中。
点击屏幕右上角的下载 CSV以下载所选仪表盘的 CSV 文件的压缩文件。
PDF 中的表格数据
注意
在 Grafana Enterprise v10.3+ 中通过 Grafana 图像渲染插件 v3.0+ 提供公开预览 (
pdfTables
功能开关),以及在 Grafana Cloud 中也可用。
当您的表格可视化数据多于仪表盘 PDF 中可显示的数据时,您可以选择以下两个选项之一来在报告中以 PDF 格式访问所有表格可视化数据
- 将表格数据包含在 PDF 附录中 - 向仪表盘 PDF 添加附录。
- 附加单独的表格数据 PDF 文件 - 生成一个单独的 PDF 文件。
3. 计划
在此步骤中,设置计划信息。选项因您选择的频率而异。
选项 | 描述 |
---|---|
频率 | 您可以计划报告发送一次,或按小时、每天、每周或每月重复发送,或按自定义间隔发送。您也可以通过选择从不来禁用计划。例如,您可能希望使用 API 发送报告。 |
时间 | 选择以下选项之一
|
结束日期 | 如果将此字段留空,报告将无限期发送。 |
仅在周一至周五发送 | 对于按小时或每天频率发送的报告,您可以选择仅在周一至周五发送。 |
在月末最后一天发送 | 当您计划按月频率发送报告,并且将开始日期设置为当月的 29 日至 31 日之间时,报告将仅在包含这些日期的月份发送。如果您希望报告每个月都发送,请选择在月末最后一天发送选项。这样,无论该月有多少天,报告都会在该月的最后一天发送。 |
4. 分享
在此步骤中,输入与分享报告相关的信息
选项 | 描述 |
---|---|
报告名称(必填) | 报告在报告列表中显示的名称。报告名称也会填充电子邮件主题行。 |
收件人(必填) | 输入您希望接收报告的人员或团队的电子邮件地址,用逗号或分号分隔。 |
回复邮件地址 | 在电子邮件的回复字段中显示的地址。 |
消息 | 包含报告的电子邮件正文。 |
包含仪表盘链接 | 在报告电子邮件中包含仪表盘链接。 |
点击屏幕右上角的发送测试邮件,以验证配置是否按预期工作,并验证电子邮件是否正常。您可以选择将此邮件发送给报告配置的收件人,或者发送给仅用于测试的不同电子邮件地址列表。
5. 确认
在此步骤中,确认页面显示所有报告设置。查看并确认它们是否正确,或点击提供的每个部分的编辑链接进行更新。
然后,点击立即发送或安排发送。
您也可以将报告保存为草稿或丢弃。丢弃报告是不可逆的。
使用 API 发送报告
您可以使用 HTTP API 通过发送报告端点以编程方式发送报告。
管理报告
在报告页面上,您可以查看和管理现有报告或创建新报告。
编辑报告
要编辑报告,请按照以下步骤操作
- 在主菜单中,点击仪表盘 > 报告。
- 点击要更新的报告所在行。
- 点击右上角的编辑报告按钮,或者点击特定部分的编辑链接直接跳转到该部分。
- 完成更改后,点击屏幕顶部的确认按钮以进入最后一步。
- 点击更新报告。
暂停或恢复报告
您可以从报告列表视图中暂停和恢复发送报告。要执行此操作,请按照以下步骤操作
在主菜单中,点击仪表盘 > 报告。
在要更新的报告所在行上,执行以下操作之一
- 点击暂停图标 - 报告将不会按照其计划发送,直到恢复。
- 点击恢复图标 - 报告将按其之前的计划恢复。
删除报告
要删除报告,请按照以下步骤操作
- 在主菜单中,点击仪表盘 > 报告。
- 在要更新的报告所在行上,点击垃圾桶图标。
- 点击删除确认。
删除报告是不可逆的。
报告故障排除
要进行故障排除并获取更多日志信息,请在配置文件中启用调试日志记录。更多信息请参阅日志过滤器配置文档。
[log]
filters = rendering:debug,report.api:debug,report.render:debug,report.scheduler:debug,report.sender:debug,report.service:debug