Use notebooks to gather related information

Use notebooks to gather information from multiple pages in Chronosphere Observability Platform. When you’re troubleshooting a problem, you might need graphs, charts, and other resources to review at the same time. Notebooks let you gather these resources in one place for ease of review.

Accounts with the None role can open and view notebooks. To create, edit, or delete a notebook, your account must be a member of a team with the Editor or SysAdmin role.

You can work with notebooks in the following ways:

• The notebooks list shows all your notebooks and opens each one in a full-screen view.
• The notebook side panel opens over any page so you can add resources without leaving your current context.

Both edit the same notebooks, so changes you make in one place appear in the other.

View notebooks

To view all your notebooks, in the navigation menu, select Notebooks. This displays a table listing notebooks you own or have recently opened, with these controls:

• Create notebook opens a new notebook in a full-screen view. See Create a notebook.
• Search notebooks filters the list by name.
• The ownership filter narrows the list:
  • All lists every notebook available to you.
  • Mine lists only notebooks in your personal collection.
  • Shared with me lists notebooks owned elsewhere that you’ve opened, such as a notebook someone shared with a link.

Each row displays the notebook Name, its Owner, the Date modified, and when you Last viewed it. The list is sorted by Last viewed by default. Click a notebook’s Name to open it in a full-screen view.

To manage a notebook from the list, click the three vertical dots icon in its row:

• Copy Link copies a shareable URL for the notebook.
• Delete removes the notebook.

Open a notebook in a full-screen view

When you open a notebook from the notebooks list, it fills the page. A full-screen notebook includes the formatting toolbar, a time range selector, Notebook settings, and Version history.

The full-screen page shows the notebook name as a read-only heading. To rename or delete the notebook, click Notebook settings. Use the Notebooks breadcrumb to return to the list.

Opening a notebook in full screen closes the notebook side panel if it was open. Closing the full-screen notebook restores the side panel.

Notebook side panel

The notebook side panel opens over any page in Observability Platform so you can gather resources without leaving your current context. Observability Platform displays the last notebook you accessed, and your open notebook stays visible as you move between pages.

Open a notebook

Where the Notebook control appears depends on whether it’s in the page header or the right sidebar. Use the tab that matches what you see, or use the keyboard shortcut N.

Page header

Click the Notebook icon in the page header, between pinned scope and search.

After the notebook opens, see Notebook header for full-screen, create, share, and version history controls.

Right sidebar

Click the Notebook icon in the right sidebar.

If the sidebar is collapsed, press Control+. (Command+. on macOS) to expand it. When Notebook was the last tab you used, the sidebar reopens to your notebook.

After the notebook opens, see the Notebook header for full-screen, create, share, and version history controls. Side panel notebooks often use a narrow header.

Switch notebooks

To switch notebooks or find a notebook you opened recently:

1. Click Select a notebook in the notebook header.
2. Select the My Notebooks or Recent Notebooks tab:
   • My Notebooks lists notebooks in your personal collection. The open notebook is labeled (current) and appears at the top of the list.
   • Recent Notebooks lists notebooks you opened recently, in order.
3. If needed, filter the list by entering a name in Search.
4. Click a Name in the table to open the selected notebook. Each row also displays a Date for when the notebook was last updated.

Notebook header

The top of the notebook side panel provides controls to view the notebook in a full-screen view, open its version history, copy its URL, and create a notebook. Observability Platform shows these controls as separate icon buttons or groups them in a menu, depending on the width of the notebook header row. The layout switches at 360 pixels. When the header row is narrower than 360 pixels, Observability Platform uses a narrow header. When the row is 360 pixels or wider, it uses a wide header. Resizing the notebook panel or using a long notebook name can change the header width and switch between layouts.

Use the tab that matches what you see:

Narrow header

In a narrow header, these actions are grouped in one menu:

1. Click the three vertical dots icon in the notebook header.
2. Click the action you need:
   • View full screen
   • Version history
   • Copy URL
   • Create notebook

Wide header

In a wide header, each action appears as its own icon in the notebook header:

• View full screen
• Version history
• Copy URL
• Create notebook

Share a notebook

Notebooks are stored in a collection. Notebooks you create are stored in your personal collection, and other users can’t see them in My Notebooks or Mine unless you share a link. When someone opens a link you share, the notebook opens in their notebook panel and appears in their Recent Notebooks and under Shared with me in the notebooks list.

To share a notebook, copy its URL using one of these controls:

• In the notebooks list, open the row’s three vertical dots menu and click Copy Link.
• In the side panel, click Copy URL in the notebook header. If Copy URL isn’t visible, click the three vertical dots icon, and then click Copy URL. See Notebook header for both header layouts.
• In Select a notebook, open the row menu and click Share.

View version history

To view the history of changes for a notebook, click Version history. In the side panel, if Version history isn’t visible, click the three vertical dots icon in the notebook header, and then click Version history. See Notebook header for both header layouts.

Click Version history to display a panel with two tabs:

• Code config: Displays a code representation of the selected entity as of the time of the selected revision.
• Code diff: Displays a Git-style diff of the most-recent change made to the entity, in Chronosphere API format. To compare the selected revision to another revision in the history, click the Compare With dropdown and select the timestamp of the revision that you want to compare.
  • Click Unified to see the diff stacked horizontally.
  • Click Split to see changes side by side.

You can see the user, service account, or actor which made and the method used for the last change at the top of the list of changes.

To view a revision in the history, click any entry in the list of timestamped revisions. The timestamps default to your local time zone.

You can view unchanged lines within the diff by clicking the Expand X lines links.

For a natural language description of the differences between versions, click Explain what has changed. An information box appears with a summary of the changes. This summary can help users who are less familiar with code updates understand changes. Use the thumbs up or thumbs down icon to indicate whether the explanation was helpful or not.

The Version History view retains up to 500 revisions, or up to 15 months of revisions if there are fewer than 500 revisions.

Restore a previous version

To restore a prior version of a notebook while reviewing its version history:

1. Select the version to revert to.
2. Click Restore to DATE, where DATE is the selected version.
3. Click Restore.

The notebook refreshes and displays the restored version.

Reload an updated notebook

If Observability Platform detects a newer saved version of the notebook than the one displayed, an alert displays: A new version of this notebook is available. This can happen in these situations:

• Another user saves changes to a shared notebook you’re viewing.
• You edit the same notebook in another browser tab.

Click Reload to load the latest saved version.

Create a notebook

If your personal collection has no notebooks when you open the notebook panel, Observability Platform creates one automatically.

To create another notebook, use one of these controls:

• Click Create notebook in the notebooks list. The new notebook opens in a full-screen view.
• In the side panel, click Create notebook in the notebook header. If Create notebook isn’t visible, click the three vertical dots icon, and then click Create notebook. See Notebook header for both header layouts.
• In the side panel, click Select a notebook, and then click Create notebook.

A new notebook opens with a default name like Untitled notebook <date and time>. To rename it in the side panel, click the name. On the full-screen page, click Notebook settings, edit Notebook name, and then click Save.

Add items to your notebook

Notebooks combine dashboard-style panels, embedded entity link cards, and free-form text.

Use one of these general methods to add items to your notebook:

• New, empty notebooks display an Add panel button. Click the button to create a custom panel.
• When Add to notebook appears in a panel menu or in page actions, you can add that visualization to a notebook.
• Paste a URL from a resource page to embed a link card. Use paste for pages that don’t offer Add to notebook on a panel, such as collections or teams pages.

To delete an item from your notebook, click the item and then press Delete.

Format text

Click anywhere in the notebook that isn’t an added resource to add notes. Format notes using the toolbar under the notebook title bar:

• Bold, Italic, and Code for inline formatting.
• Link to add or edit a hyperlink. In the Add link dialog, enter Text and Link, and then click Apply.
• Numbered list and Bulleted list for lists.

When you select text, the same formatting controls display in a menu above the selection.

Drag a panel from a dashboard

To drag a panel into your notebook:

1. Open a notebook.
2. Open a dashboard.
3. Drag a panel by its header into the notebook. When the pointer is over the notebook, Drop panel to add to notebook displays.

Create a dashboard panel in the notebook

To create a panel in the notebook:

1. Open a notebook that has no content.
2. Click Add panel.
3. Configure the panel in the Add panel dialog, and then click Apply. See Edit a panel.

Paste a dashboard panel

To paste a copied panel into the notebook:

1. Open a notebook.
2. On a dashboard, click a panel and press Control+C (Command+C on macOS) to copy it.
3. Click in the notebook text area and press Control+V (Command+V on macOS) to paste the panel.

From Logs Explorer

In Logs Explorer, add the current query to a notebook from the page actions above the query results.

To add a Logs Explorer query to a notebook:

1. Open a notebook, or leave the notebook closed to pick a notebook when you add content.
2. Open Logs Explorer.
3. Enter a query. Add to notebook is disabled until the query field contains text.
4. To match a specific chart type in the notebook, select a visualization for the query results.
5. Click Add to notebook in the page actions.

If a notebook is already open, Observability Platform adds the panels to that notebook. Otherwise, select a notebook in the Add panel to notebook dialog, or click Add to new notebook.

Observability Platform adds two panels to the notebook:

• A log volume histogram for the query
• A panel that matches the selected visualization, such as list, table, or time series

Both panels use the Logs Explorer time range.

From another page

You can add a panel to a notebook from any page that shows Add to notebook in its panel menu, such as dashboards and service pages.

To add a panel from its menu:

1. Hold the pointer over the panel, and then click the three vertical dots icon.
2. Select Add to notebook.
3. Select a notebook, or click Add to new notebook to create a new notebook.

The selected resource appears at the bottom of your notebook.

Paste entity links into the notebook

Paste a URL copied from a resource page in Observability Platform to embed a link card labeled with the resource type and name. Click the card to open the resource.

To paste entity links:

1. Click in the notebook text area.
2. Paste the URL with Control+V (Command+V on macOS).

Paste each URL on its own line to add multiple resource cards.

Delete a notebook

To delete a notebook:

• On the full-screen notebook page, click Notebook settings, and then click Delete notebook.
• In the notebooks list, click the three vertical dots icon in the notebook’s row, and then click Delete.
• In the side panel:
  1. Open a notebook.
  2. Click Select a notebook in the notebook header.
  3. Next to the notebook you want to delete, click the three vertical dots icon and then click Delete.

Customize panels in a notebook

Change panel time ranges, open the panel editor to update queries and display options, or capture snapshots.

Change the time range

Change the time range for the entire notebook to shift all panels together, or override the time range on individual panels. For example, if there’s an anomaly in a graph in your notebook, add a second copy of the panel and change its time range to the same time last week to compare patterns.

To change the time range for the entire notebook:

1. In the notebook, click the time range selector under the format toolbar.
2. Select a time range. See Select time ranges for preset, custom, and calendar options.

Panels without a per-panel override use the notebook time range. Panels with an override keep their own time until you reset them.

To override the notebook time range for one panel:

1. Hold the pointer over the panel.
2. Click the clock icon.
3. Select an available time range, or Custom time range to set your own.

The customized time range appears in the panel as a chip under the panel name.

To reset the time range, click the x in the time range chip, or click the clock icon and select Use notebook time.

Edit panel contents

To update a panel in a notebook:

1. Click the Edit icon.
2. Edit the panel.

Not all panel editing operations are available in notebooks. For example, you can’t change the panel type.

Take a snapshot

Take a snapshot of a panel to capture specific data on a longer-term, static basis.

1. Add a panel to your notebook.
2. In the selected panel, click the three vertical dots icon.
3. Select Capture snapshot.

The panel updates to indicate its snapshot status by adding Snapshot under the panel title.

The snapshot time range displays next to the snapshot indicator. Zooming in on a time range updates the time range chip, and adds an x to the chip. Click the x to return to the original snapshot.