笔记本
OpenSearch Dashboards 笔记本是一种界面,可让您轻松地将代码片段、实时可视化和叙述文本组合到单个笔记本界面中。
笔记本允许您通过运行不同的可视化效果来交互式探索数据,您可以与团队成员共享这些可视化效果以协作完成项目。
笔记本是由两个元素组成的文档:代码块(Markdown/SQL/PPL)和可视化。选择多个时间线以比较和对比可视化效果。
您还可以直接从笔记本生成报告。
常见用例包括创建事后报告、设计运行手册、构建实时基础架构报告以及编写文档。
OpenSearch Dashboards 中的租户是用于保存笔记本和其他 OpenSearch Dashboards 对象的空间。有关更多信息,请参阅OpenSearch Dashboards 多租户。
笔记本入门
要开始使用,请在 OpenSearch Dashboards 中选择 Notebooks。
步骤 1:创建笔记本
笔记本是用于创建报告的界面。
- 选择 Create notebook(创建笔记本)并输入一个描述性名称。
- 选择 Create。
选择 Actions(操作)以重命名、复制或删除笔记本。
步骤 2:添加段落
段落结合了代码块和可视化,用于描述数据。
添加代码块
代码块支持 markdown、SQL 和 PPL 语言。
在第一行使用 %[language type]
语法指定输入语言。例如,markdown 类型 %md
,SQL 类型 %sql
,PPL 类型 %ppl
。
Markdown 块示例
%md
Add in text formatted in markdown.
SQL 块示例
%sql
Select * from opensearch_dashboards_sample_data_flights limit 20;
PPL 块示例
%ppl
source=opensearch_dashboards_sample_data_logs | head 20
添加可视化
- 要添加可视化,请选择 Add paragraph(添加段落)并选择 Visualization(可视化)。
- 在 Title(标题)中,选择您的可视化并选择日期范围。您可以选择多个时间线以比较和对比可视化。
- 要运行和保存段落,请选择 Run(运行)。
段落操作
您可以对段落执行以下操作
- 在报告顶部添加新段落。
- 在报告底部添加新段落。
- 同时运行所有段落。
- 清除所有段落的输出。
- 删除所有段落。
示例笔记本
我们准备了以下示例笔记本,展示了各种用例
- 使用 SQL 查询 OpenSearch Dashboards 示例航班数据。
- 使用 PPL 查询 OpenSearch Dashboards 示例网络日志数据。
- 使用 PPL 和可视化对 OpenSearch Dashboards 示例网络日志数据执行示例根本原因事件分析。
要添加示例笔记本,请选择 Actions(操作)并选择 Add sample notebooks(添加示例笔记本)。
创建报告
您可以使用笔记本创建 PNG 和 PDF 报告
- 从顶部菜单栏中,选择 Reporting actions(报告操作)。
-
您可以选择 Download PDF(下载 PDF)或 Download PNG(下载 PNG)。
报告在后台异步生成,可能需要几分钟,具体取决于报告的大小。当您的报告准备好下载时,会出现通知。
- 要创建基于计划的报告,请选择 Create report definition(创建报告定义)。有关创建报告定义的步骤,请参阅使用定义创建报告。
- 要查看所有报告,请选择 View all reports(查看所有报告)。