opensearch-docs-cn/_dashboards/notebooks.md

125 lines
4.3 KiB
Markdown
Raw Normal View History

2021-05-28 13:48:19 -04:00
---
layout: default
2021-07-08 17:30:19 -04:00
title: Notebooks
2021-05-28 13:48:19 -04:00
nav_order: 50
redirect_from: /notebooks/
2021-05-28 14:19:18 -04:00
has_children: false
2021-05-28 13:48:19 -04:00
---
2021-07-08 17:30:19 -04:00
# Notebooks
2021-05-28 13:48:19 -04:00
2021-07-08 17:30:19 -04:00
An OpenSearch Dashboards notebook is an interface that lets you easily combine code snippets, live visualizations, and narrative text in a single notebook interface.
2021-05-28 13:48:19 -04:00
Notebooks let you interactively explore data by running different visualizations that you can share with team members to collaborate on a project.
2021-07-08 17:30:19 -04:00
A notebook is a document composed of two elements: code blocks (Markdown/SQL/PPL) and visualizations. Choose multiple timelines to compare and contrast visualizations.
You can also generate [reports]({{site.url}}{{site.baseurl}}/dashboards/reporting/) directly from your notebooks.
2021-05-28 13:48:19 -04:00
Common use cases include creating postmortem reports, designing runbooks, building live infrastructure reports, and writing documentation.
2021-07-08 17:30:19 -04:00
Tenants in OpenSearch Dashboards are spaces for saving notebooks and other OpenSearch Dashboards objects. For more information, see [OpenSearch Dashboards multi-tenancy]({{site.url}}{{site.baseurl}}/security-plugin/access-control/multi-tenancy/).
{: .note }
2021-05-28 13:48:19 -04:00
2021-07-08 17:30:19 -04:00
## Get started with notebooks
2021-05-28 13:48:19 -04:00
2021-07-08 17:30:19 -04:00
To get started, choose **Notebooks** within OpenSearch Dashboards.
2021-05-28 13:48:19 -04:00
### Step 1: Create a notebook
A notebook is an interface for creating reports.
1. Choose **Create notebook** and enter a descriptive name.
1. Choose **Create**.
2021-07-08 17:30:19 -04:00
Choose **Actions** to rename, duplicate, or delete a notebook.
2021-05-28 13:48:19 -04:00
2021-07-16 02:47:36 -04:00
![Create notebook]({{site.url}}{{site.baseurl}}/images/create_notebook.gif)
2021-05-28 13:48:19 -04:00
### Step 2: Add a paragraph
2021-07-08 17:30:19 -04:00
Paragraphs combine code blocks and visualizations for describing data.
2021-05-28 13:48:19 -04:00
2021-07-08 17:30:19 -04:00
#### Add a code block
2021-05-28 13:48:19 -04:00
2021-07-08 17:30:19 -04:00
Code blocks support markdown, SQL, and PPL languages.
2021-05-28 13:48:19 -04:00
2021-07-08 17:30:19 -04:00
Specify the input language on the first line using `%[language type]` syntax.
For example, type `%md` for markdown, `%sql` for SQL, and `%ppl` for PPL.
##### Sample markdown block
```
%md
Add in text formatted in markdown.
```
2021-05-28 13:48:19 -04:00
2021-07-16 02:47:36 -04:00
![Markdown paragraph]({{site.url}}{{site.baseurl}}/images/markdown_notebooks.gif)
2021-05-28 13:48:19 -04:00
2021-07-08 17:30:19 -04:00
##### Sample SQL block
```sql
%sql
Select * from opensearch_dashboards_sample_data_flights limit 20;
```
2021-07-16 02:47:36 -04:00
![SQL paragraph]({{site.url}}{{site.baseurl}}/images/sql_notebooks.gif)
2021-07-08 17:30:19 -04:00
##### Sample PPL block
```
%ppl
source=opensearch_dashboards_sample_data_logs | head 20
```
2021-07-16 02:47:36 -04:00
![PPL paragraph]({{site.url}}{{site.baseurl}}/images/ppl_notebooks.gif)
2021-07-08 17:30:19 -04:00
2021-05-28 13:48:19 -04:00
2021-07-08 17:30:19 -04:00
#### Add a visualization
2021-05-28 13:48:19 -04:00
2021-07-08 17:30:19 -04:00
1. To add a visualization, choose **Add paragraph** and select **Visualization**.
2021-05-28 13:48:19 -04:00
1. In **Title**, select your visualization and choose a date range. You can choose multiple timelines to compare and contrast visualizations.
1. To run and save a paragraph, choose **Run**.
2021-07-16 02:47:36 -04:00
![Visualization paragraph]({{site.url}}{{site.baseurl}}/images/visualization_notebooks.gif)
2021-07-08 17:30:19 -04:00
## Paragraph actions
2021-05-28 13:48:19 -04:00
You can perform the following actions on paragraphs:
- Add a new paragraph to the top of a report.
- Add a new paragraph to the bottom of a report.
- Run all the paragraphs at the same time.
- Clear the outputs of all paragraphs.
- Delete all the paragraphs.
2021-07-16 02:47:36 -04:00
![Sample notebooks]({{site.url}}{{site.baseurl}}/images/paragraphs_notebooks.gif)
2021-07-08 17:30:19 -04:00
## Sample notebooks
We prepared the following sample notebooks that showcase a variety of use cases:
- Using SQL to query the OpenSearch Dashboards sample flight data.
- Using PPL to query the OpenSearch Dashboards sample web logs data.
- Using PPL and visualizations to perform sample root cause event analysis on the OpenSearch Dashboards sample web logs data.
To add a sample notebook, choose **Actions** and select **Add sample notebooks**.
2021-07-16 02:47:36 -04:00
![Sample notebooks]({{site.url}}{{site.baseurl}}/images/sample_notebooks.gif)
2021-07-08 17:30:19 -04:00
## Create a report
You can use notebooks to create PNG and PDF reports:
1. From the top menu bar, choose **Reporting actions**.
1. You can choose to **Download PDF** or **Download PNG**.
Reports generate asynchronously in the background and might take a few minutes, depending on the size of the report. A notification appears when your report is ready to download.
1. To create a schedule-based report, choose **Create report definition**. For steps to create a report definition, see [Create reports using a definition]({{site.url}}{{site.baseurl}}/dashboards/reporting#create-reports-using-a-definition).
1. To see all your reports, choose **View all reports**.
2021-07-16 02:47:36 -04:00
![Report notebooks]({{site.url}}{{site.baseurl}}/images/report_notebooks.gif)