Skip to content
This repository was archived by the owner on Aug 16, 2022. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/images/kibana-notebooks.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/markdown-notebook.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/notebook.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/output-notebook.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/visualization-notebook.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
64 changes: 64 additions & 0 deletions docs/notebooks/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the gif above is very old version of the software, where did you get it from ?

layout: default
title: Notebook
nav_order: 38
has_children: false
---

# Kibana Notebook

A Kibana notebook is an interface that lets you easily combine live visualizations and narrative text in a single notebook interface.

With Kibana notebooks, you can interactively explore data by running different visualizations and share your work with team members to collaborate on a project.

You can add visualization paragraphs for creating graphs and markdown paragraphs for writing descriptions. You can choose multiple timelines to compare and contrast visualizations.

Common use cases include creating postmortem reports, designing runbooks, building live infrastructure reports, and writing documentation.

## Get Started with Notebooks

To get started, choose **Kibana Notebooks** in Kibana.

### 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**.

![Notebook UI](../images/notebook.png)

Choose **Notebook actions** to rename, duplicate, or delete a notebook.

### Step 2: Add a paragraph

Paragraphs combine text and visualizations for describing data.

#### Add a markdown paragraph
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capitalize Markdown and add a link to documentation for whatever flavor we're using (probably CommonMark or GFM) in the description.

Examples:

https://github.github.com/gfm/
https://commonmark.org


1. To add text, choose **Add markdown paragraph**.
1. Add rich text with markdown syntax.

![Markdown paragraph](../images/markdown-notebook.png)

#### Add a visualization paragraph

1. To add a visualization, choose **Add Kibana visualization paragraph**.
1. In **Title**, select your visualization and choose a date range.

![Markdown paragraph](../images/visualization-notebook.png)

- You can choose multiple timelines to compare and contrast visualizations.

To run and save a paragraph, choose **Run**.

![Output](../images/output-notebook.png)

You can perform the following actions on paragraphs:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there no sequential drilling down on data as you progress through the notebook? It's just visualizations and paragraphs?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the inspect button on output only is clicked, it shows the data. @anirudha to confirm.


- 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.
- Move paragraphs up and down.