Notebooks

Notebooks

Overview

Notebooks combine graphs and text in a linear, cell-based format. They help you explore and share stories with your data by creating postmortems, investigations, runbooks, documentation, and more.

Live collaboration

Notebooks support real-time collaboration. Presence indicators show who is viewing your notebook at any time; indicators also appear beside any cell that another user is currently editing.

Changes made to a notebook appear automatically, without the need to refresh.

Everyone on your team can open or edit any notebook, but a notebook can only be deleted by the creator or by an administrator.

Commenting

To add a comment, select some text or hover over a graph. The Add comment button will appear to the right of the cell.

To edit or delete a comment you wrote, click the menu on the top-right of your comment.

View or re-open resolved comments in the Comment History, available in the Notebook cog menu.

Notebook authors receive email notifications for new comments on their notebooks, and commenters are notified for replies to their comments. Manage your notification settings through Notifications in the notebook cog menu.

Notebook List

The Notebook List allows you to view and search previously created notebooks. Each notebook’s name, creator, and last modified date are displayed. Notebooks are grouped by:

  • My Notebooks: Notebooks created by you.
  • Other Notebooks: Notebooks created by other members of your team.

The Notebook List also displays preset templates and tutorials. Edit these templates directly, and click Clone to save your changes.

New Notebook

Create a new notebook from the main navigation: Notebooks > New Notebook.

A new notebook is not saved by default. You must click the Save button.

Types of content

Notebooks support visualizations and text cells.

Visualization

Graphs in notebooks support all Datadog data sources: metrics, log events, Indexed Spans, live processes, network traffic, RUM events, profiling metrics, and security signals.

Graphs are created with the Datadog query editor. Notebooks support:

Text

Text in a notebook is formatted with Markdown, which enables the use of headings, subheadings, links, images, lists, and code blocks.

Manipulating cells

When an existing notebook is opened, the cells are in a closed state. To open a cell for editing, mouse over it and use CMD + Click, or click Edit. To close a cell, click outside it, press ESC, or press CMD + Enter. Only one cell may be open at a time.

To insert cells, use the + button that appears to the left of the cell. To share, clone, or delete cells, use the action tray that appears above the cell on hover, or use a keyboard shortcut. A list of all keyboard shortcuts is available by clicking the keyboard button in the notebook header.

Time frames

By default, all graph cells are linked to the global time frame set in the notebook header.

To view a different time frame, select an option in the global time picker, or scrub on a graph directly. The Notebook URL will update to reflect this new time frame without saving it to the Notebook.

Note: Clicking and dragging to zoom in on a graph does not unlock the cell from the global time. It changes the notebook’s global time instead.

To save this time as the Notebook’s default, click Update Default. The reset button will discard your changes to time.

Individual cells can be unlinked from the global time and set to an independent time frame.

To view a different time frame on a single cell, edit the cell and use the toggle to unlink it from Global Time. Change the time frame using the time picker or by scrubbing on the graph. Changes made in edit mode are saved automatically when you click Done. To discard your changes, click Cancel instead of Done.

Expand

Expand the graph by clicking on the expand icon on the right side of the cell. More details about full screen mode is available on the Widgets page.

Layout options

The following layout options are available by clicking the grid icon on the right side of the cell in edit mode:

  • Graph size: Choose between XS, S, M (default), L, and XL.
  • Graph legend: Uncheck the box to hide the legend. Legends are automatically disabled for XS and S graphs.
  • Grouping: Display one graph per tag value to see small multiples of your visualization.

Note: Changing any of these settings only affects the targeted cell.

Further Reading