-
Notifications
You must be signed in to change notification settings - Fork 183
EASE doc updates #2409
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
Merged
Merged
EASE doc updates #2409
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
6a4a66a
EASE doc updates
benironside 0ab7329
edits
benironside 17f7582
fixes attribute
benironside 51946c7
Update ease-intro.md
benironside e8816f9
Update create-security-project.md
benironside dda0b5c
Update ease-intro.md
benironside 61b8d22
new ease alerts page
benironside 2289e31
Update ease-alerts.md
benironside 7672e42
adds value report page
benironside 4678be4
Merge branch 'main' into docs-internal-repo-167-AI4SOC-mvp
benironside 1e530b8
Apply suggestions from code review
benironside 14d67b5
Incorporates Mike's review and other edits
benironside e7bb633
Update ease-intro.md
benironside f5e12e8
verbiage upgrade
benironside 39f61f0
Merge branch 'main' into docs-internal-repo-167-AI4SOC-mvp
benironside File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| --- | ||
| navigation_title: Triage alerts | ||
| applies_to: | ||
| serverless: | ||
| security: preview | ||
| --- | ||
|
|
||
| # Triage alerts in EASE | ||
|
|
||
| Once you've ingested your alerts to Elastic AI SOC Engine (EASE), you can view, track, and analyze them from the **Alert summary** page. | ||
|
|
||
| :::{image} /solutions/images/security-ease-alerts-summary.png | ||
| :alt: The Alert summary page of an EASE project | ||
| ::: | ||
|
|
||
| ## View alert details | ||
|
|
||
| An alert's details flyout shows its basic information, highlighted fields, and any associated attack discoveries. It also enables you to generate an AI summary of the alert, or collaborate with AI Assistant to continue your investigation. | ||
|
|
||
| To open the alert details flyout, select the **Expand** button ({icon}`expand`) from the alert's row in the alerts table. | ||
|
|
||
| :::{image} /solutions/images/security-ease-alert-flyout.png | ||
| :alt: The Alert summary page of an EASE project | ||
| ::: | ||
|
|
||
| You can take several actions from the alert details flyout: | ||
|
|
||
| - **Generate insights**: To generate an AI description of the alert with recommended actions, click **Generate insights**. (The connector used here is the default LLM for your project. To update it, navigate to the **Advanced settings** page using the navigation menu or the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md), and update the **Default AI Connector**.) | ||
|
|
||
| :::{note} | ||
| The recommended actions are informed by any relevant custom knowledge you may have added to the AI Assistant's [knowledge base](/solutions/security/ai/ai-assistant-knowledge-base.md). For example, if you have specified a particular teammate is responsible for a particular type of alert of part of your infrastructure, it would recommend contacting that person. | ||
| ::: | ||
|
|
||
| - **Ask AI Assistant**: To start a conversation with [AI Assistant](/solutions/security/ai/ai-assistant.md), select one of the suggested prompts or click **Ask AI Assistant**. | ||
| - **Add to case**: To add an alert to a new or existing case, scroll to the bottom and click **Take action**, then **Add to existing case** or **Add to new case**. | ||
| - **Apply alert tags**: To add tags to an alert, scroll to the bottom of its flyout and click **Take action**, then **Apply alert tags**. (To create new tags, navigate to the **Advanced settings** page using the navigation menu or the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md), and update the **Alert tagging options**.) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| --- | ||
| navigation_title: Elastic AI SOC Engine | ||
| applies_to: | ||
| serverless: | ||
| security: preview | ||
| --- | ||
| # Elastic AI SOC Engine with {{sec-serverless}} | ||
|
|
||
| Elastic AI Security Operations Center (SOC) Engine (EASE) is an {{sec-serverless}} project type that provides AI-powered tools and case management to augment third-party SIEM and EDR/XDR platforms. This page describes how to create an {{sec-serverless}} EASE project, how to ingest your data, and how to use its key features. | ||
|
|
||
| ## Create an EASE project | ||
|
|
||
| To create an EASE project: | ||
|
|
||
| 1. [Create](/solutions/security/get-started/create-security-project.md) an {{sec-serverless}} project, and on the **Confirm your project settings** page, select **Elastic AI SOC Engine**. | ||
|
|
||
| :::{image} /solutions/images/security-ease-create-ease-project.png | ||
| :alt: The Confirm your project settings page | ||
| ::: | ||
|
|
||
| 2. Click **Create serverless project**, and wait for your project to be provisioned. When it's ready, open it. | ||
|
|
||
|
|
||
| ## Ingest your SOC data | ||
|
|
||
| To ingest your SOC data: | ||
|
|
||
| 1. Go to the **Configurations** page using the navigation menu or the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). | ||
|
|
||
| :::{image} /solutions/images/security-ease-integrations.png | ||
| :alt: The integrations page of an EASE project | ||
| ::: | ||
|
|
||
| 2. From the **Integrations** tab, select any [integration](integration-docs://reference/index.md) you want to ingest data from to view deployment instructions and more information. | ||
|
|
||
| ## Select a model | ||
|
|
||
| EASE uses LLM connectors to enable its AI features such as Attack Discovery and AI Assistant. The Elastic Managed LLM is enabled by default. You can also [create custom connectors](/solutions/security/ai/set-up-connectors-for-large-language-models-llm.md). Keep in mind that different models [perform differently](/solutions/security/ai/large-language-model-performance-matrix.md) on different tasks. | ||
|
|
||
|
|
||
| ## Features | ||
|
|
||
| EASE provides a set of capabilities designed to help make the most of each security analyst’s time, fight alert fatigue, and reduce your mean time to respond. Once your data is ingested, you can start using the following features: | ||
|
|
||
| - **[Attack Discovery](/solutions/security/ai/attack-discovery.md)**: Helps you analyze alerts in your environment and identify threats. Each discovery represents a potential attack and describes relationships among multiple alerts to tell you which users and hosts are involved, how alerts correspond to the MITRE ATT&CK matrix, and which threat actor might be responsible. | ||
|
|
||
| :::{image} /solutions/images/security-attck-disc-example-disc.png | ||
| :alt: Attack Discovery detail view | ||
| ::: | ||
|
|
||
| - **[AI Assistant](/solutions/security/ai/ai-assistant.md)**: An LLM-powered virtual assistant specialized for digital security; it helps with data analysis, alert investigation, incident response, and {{esql}} query generation. You can add custom background knowledge and data to its [knowledge base](/solutions/security/ai/ai-assistant-knowledge-base.md) and use natural language to ask for its assistance with your SOC operations. | ||
|
|
||
| - **[Cases](/solutions/security/investigate/cases.md)**: Helps you track and share related information about security issues. Track key investigation details and collect alerts in a central location. | ||
|
|
||
| :::{image} /solutions/images/security-ease-cases.png | ||
| :alt: The Cases page in an EASE project | ||
| ::: | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| --- | ||
| navigation_title: Value report | ||
| applies_to: | ||
| serverless: | ||
| security: preview | ||
| --- | ||
|
|
||
| # EASE Value Report | ||
|
|
||
| The **Value report** page estimates your savings from using Elastic AI SOC Engine (EASE) for alert triage, in terms of **Analyst time saved** and **Cost Savings**. The message at the top of the page explains how those numbers were determined, and how many alerts were **Escalated** and **Filtered** by AI. | ||
|
|
||
| You can interact with the page in the following ways: | ||
|
|
||
| - **Update the time range:** Use the time selector in the upper right corner to select the time range for which to show value metrics. | ||
| - **Export report:** Select **Export report** in the upper right corner to download a sharable PDF of the value report. | ||
|
|
||
|
|
||
| :::{image} /solutions/images/security-ease-value-report.png | ||
| :alt: The Value Report in an EASE project | ||
| ::: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.