Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add notebooks documentation #2143

Merged
merged 7 commits into from
Jan 10, 2025
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/assets/operation_center/notebook.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/assets/operation_center/notebook_case.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/assets/operation_center/notebook_changes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/assets/operation_center/notebook_delete.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/assets/operation_center/notebook_menu.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/assets/operation_center/notebook_pdf.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/assets/operation_center/notebook_share.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/assets/operation_center/notebook_viz.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/xdr/features/investigate/ai_cases.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AI Cases
# AI Cases (coming soon)

## Table of Contents
1. [Overview](#overview)
Expand Down
163 changes: 163 additions & 0 deletions docs/xdr/features/investigate/notebooks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
# Notebooks (coming soon)

## Table of Contents
1. [Overview](#overview)
2. [Feature Benefits](#feature-benefits)
3. [Getting Started with Notebooks](#getting-started-with-notebooks)
4. [Creating and Managing Notebooks](#creating-and-managing-notebooks)
5. [Notebook Templates](#notebook-templates)
6. [Command Menu and Formatting](#command-menu-and-formatting)
7. [Sharing Notebooks](#sharing-notebooks)
8. [Notebook Management](#notebook-management)
9. [Notebook Practices](#best-practices)

## Overview
Notebooks is a powerful incident response feature that allows SOC analysts to centralize their `investigation queries`, `automation actions`, and `reporting` in a single document. With support for markdown syntax and rich media, Notebooks streamlines the incident response process and facilitates team collaboration.

![notebook](/assets/operation_center/notebook.gif){: style="max-width:100%"}

## Feature Benefits
* Centralized incident response
* Embedded queries and automations
* Customizable templates for different threat types
* Rich text formatting with markdown support
* Standardized response processes
* PDF export
* Multi-tenant sharing capabilities

## Getting Started with Notebooks

### Types of Notebooks
**Standalone Notebooks**

* Independent notebooks for general use (threat hunting, custom reporting)
* Accessible from the `Notebooks menu`

**Context-linked Notebooks**

* Attached to specific `cases` or `alerts` for incident response
* Directly accessible from the `Notebooks tab` within cases or alerts
* Provides centralized investigation context

## Creating and Managing Notebooks

### Creating a New Notebook
1. Navigate to the `Notebooks tab` within a case or an alert
2. Click `New Notebook`
3. Edit blank notebook or use an existing template

![notebook_blank](/assets/operation_center/notebook_case.png){: style="max-width:100%"}

!!! Warning
In a **multi-tenant** environment, notebooks are created in the **parent** workspace by default. They are not visible to child tenants unless you explicitly share the notebook with them.

### Basic Features
* Markdown syntax support
* Image attachment for evidence collection
* Multi datasources querying
* Investigation findings documentation
* Automations execution
* Real-time modifications saving

!!! Info
Currently, Markdown table syntax is not supported.

### Tracking Changes
* Last modification date
* Last modification author

![notebook_changes](/assets/operation_center/notebook_changes.png){: style="max-width:100%"}

## Notebook Templates

### Template Management
Enhance incident response capabilities by creating template notebooks tailored to different threat types:

* Phishing investigations
* Malware analysis
* Intrusion containment
* Any custom threat responses

### Template Features
* Pre-defined investigation steps
* Threat tailored query templates
* Suggested remediation actions
* Guidance for analysts

### Setting Default Notebook Template For Cases/Alerts
1. Navigate to Notebook templates
2. Select desired template
3. Set as `default` for cases and alerts

The `default` notebook template will be suggested for use in cases and alerts, enabling the SOC team to standardize their response processes.

![notebook_template](/assets/operation_center/notebook_template.gif){: style="max-width:100%"}
Copy link
Contributor

Choose a reason for hiding this comment

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

the .gif is low quality, we can't see the text clearly


### Template Creation Methods
* Create notebook template from scratch
* Convert existing notebook to template

![notebook_convert_template](/assets/operation_center/notebook_convert_template.gif){: style="max-width:100%"}

## Command Menu and Formatting

### Accessing the Command Menu
* Press the slash key (/) to open the Command menu
* Access notebook capabilities

![notebook_command](/assets/operation_center/notebook_command.gif){: style="max-width:100%"}

!!! Tip
When the command menu is open, quickly search for an integration by typing its name.

### Available Commands
* Text formatting options
* Query builder insertion
* Automation insertion

![notebook_menu](/assets/operation_center/notebook_menu.png){: style="max-width:100%"}

### Query Builder Editor
* Display data in tables
* Create various data visualizations, including pie charts, line charts, bar charts, column charts, and numeric displays

![notebook_viz](/assets/operation_center/notebook_viz.png){: style="max-width:100%"}

## Sharing Notebooks

### Export notebook as PDF

Convert notebooks into PDF files to efficiently share incident, threat hunting, and KPI reports.

![notebook_share](/assets/operation_center/notebook_pdf.gif){: style="max-width:100%"}
Copy link
Contributor

Choose a reason for hiding this comment

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

Same for this .gif, try uploading it with a more zoomed screen (or using AMA cool tool for screenshots!)


### Multi-tenant support
* Individual notebook sharing
* Customer-specific reporting
* Secure information distribution

Share notebooks and templates directly with child tenants to ensure secure information distribution, provide incident reports, and share best practices with customers.

![notebook_share](/assets/operation_center/notebook_share.gif){: style="max-width:100%"}

## Notebook Management

### Organization
* Use the search bar to find notebooks by their titles

### Deletion and Recovery
* Soft delete notebooks to trash
* 30-day recovery period
* Permanent deletion after 30 days
* Restore option available

![notebook_share](/assets/operation_center/notebook_delete.gif){: style="max-width:100%"}

## Best Practices
1. Use templates for standardized investigations
2. Document all investigation steps
3. Include relevant screenshots and evidence
4. Utilize data visualization for complex data
5. Maintain consistent formatting
6. Regular template updates
7. Proper sharing permissions management
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ nav:
- Events Query Language: xdr/features/investigate/events_query_language.md
- Querying Events: xdr/features/investigate/querying_events.md
- Query Builder (beta): xdr/features/investigate/query_builder.md
- Notebooks (coming soon): xdr/features/investigate/notebooks.md
- Report:
- Dashboards: xdr/features/report/dashboards.md
- Threat Landscape: xdr/features/report/threat_landscape.md
Expand Down Expand Up @@ -614,6 +615,7 @@ plugins:
operation_center/events.md: xdr/features/investigate/events.md
operation_center/faq.md: xdr/FAQ.md
operation_center/intakes.md: xdr/features/collect/intakes.md
operation_center/notebooks.md: xdr/features/investigate/notebooks.md
operation_center/operators.md: xdr/features/automate/operators.md
operation_center/playbook_overview.md: xdr/features/automate/index.md
operation_center/rules.md: xdr/features/detect/rules_catalog.md
Expand Down
Loading