Notebooks¶

Notebooks are Guance's built-in structured knowledge carriers, designed specifically for observability scenarios to consolidate key information generated during fault analysis, performance troubleshooting, and other processes. Notebooks support embedding real-time data charts directly within the body, ensuring the recorded content remains associated with the system's actual state. They can be shared with workspace members, facilitating problem backtracking, localization, and collaborative handling.

Create a Notebook¶

Navigate to Notebooks, click Create Notebook, define the notebook title, and then begin editing. The notebook body supports Markdown format, allowing you to insert text or Chart Blocks as needed. After editing, click Preview in the upper right corner to switch to preview mode, where Chart Blocks will be rendered as interactive charts in real time.

For details, see Create/Edit a Notebook.

Core Features¶

Structured Recording¶

Each notebook supports configuring attributes such as title, visibility, tags, and business tags (KV format). Business tags are used to associate with specific business objects and are the core path for AI retrieval, for example, service:checkout, host:prod-node-01.

Chart Block¶

The notebook body supports the Chart Block syntax extension, which renders as interactive charts in real time in preview mode. It supports seven chart types: time series line charts, numerical overviews, tables, bar charts, alert event timelines, pie charts, and honeycomb charts. The data comes from real-time queries within the workspace.

In edit mode, you can directly fill in the chart type, query statement, and display parameters according to the syntax in the Chart Block Configuration Guide. Alternatively, you can view the charts rendered by the platform's chart components executing queries during preview.

Multi-Tab Pages¶

The notebook editing area supports opening multiple notebooks simultaneously, displayed side-by-side as Tab pages. This is suitable for referencing multiple historical records simultaneously when handling faults. The previously opened Tab state is automatically retained when re-entering the Notebooks module.

Multi-Module Linkage¶

By configuring business tags (KV format) for notebooks, notebooks can automatically associate with objects from other Guance modules. In the detail pages of objects such as hosts, services, dashboards, and traces, you can directly access the list of notebooks associated with that object without jumping to the Notebooks module, enabling knowledge consolidation and reference within the context.

For example, after adding the host:prod-node-01 tag to a notebook, that notebook will automatically appear in the "Notebooks" Tab of the corresponding host's detail page.

Manage Notebooks¶

Notebook List Options¶

• Search: Search notebooks by keywords.
• Favorite: Click the favorite icon on the right side of a notebook. After favoriting, you can view it under the My Favorites shortcut.
• Delete: Click the operation menu in the upper right corner of a notebook, select Delete, and confirm to delete the current notebook.

Filtering and Retrieval¶

The left sidebar supports filtering notebooks by tags and business tags, and provides the following shortcuts:

• All Notebooks: All notebooks within the workspace.
• My Favorites: Notebooks favorited by the current user.
• Created by Me: All notebooks created by the current user.
• Private Notebooks: Notebooks visible only to the creator.

Visibility¶

Notebooks support configuring the following two visibility levels:

• Public: Viewable by all members of the workspace.
• Private: Viewable and editable only by the creator.

Get Started¶