-
Notifications
You must be signed in to change notification settings - Fork 206
[DOCS] Case enhancements in 8.3 #2050
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
Changes from all commits
Commits
Show all changes
60 commits
Select commit
Hold shift + click to select a range
7d24ce1
First draft
nastasha-solomon 7e91673
Ref edits
nastasha-solomon bc7b444
Changed anchor and updated image
nastasha-solomon 2e831d9
Modified index
nastasha-solomon 8c966be
Update docs/cases/cases-manage.asciidoc
nastasha-solomon ef6526b
Update docs/cases/cases-manage.asciidoc
nastasha-solomon 7b155d7
More images
nastasha-solomon 2310a3a
Update docs/cases/cases-manage.asciidoc
nastasha-solomon 762331c
Added intro text
nastasha-solomon 63e76a1
Merge branch 'case-enhancements-8.3' of github.com:elastic/security-d…
nastasha-solomon 939d0c7
New section and images
nastasha-solomon 1960c37
Merge branch 'main' into case-enhancements-8.3
nastasha-solomon a46a82d
Adding inline images
nastasha-solomon 06aaf8d
Minor edits
nastasha-solomon c53e448
Updated section titles
nastasha-solomon 3bb8d8f
Image for selecting an existing case
nastasha-solomon 8ee73af
Update docs/detections/alerts-ui-manage.asciidoc
nastasha-solomon a446e15
More images
nastasha-solomon 7757865
Merge branch 'case-enhancements-8.3' of github.com:elastic/security-d…
nastasha-solomon 591d34f
Update docs/detections/alerts-ui-manage.asciidoc
nastasha-solomon 142e220
Update docs/detections/alerts-ui-manage.asciidoc
nastasha-solomon c66b1e6
Update docs/detections/alerts-ui-manage.asciidoc
nastasha-solomon b72d0ad
Update docs/detections/alerts-ui-manage.asciidoc
nastasha-solomon 373b308
Removed tip
nastasha-solomon 2f9f281
Merge branch 'main' into case-enhancements-8.3
nastasha-solomon 9324a91
Merge branch 'main' into case-enhancements-8.3
nastasha-solomon ed8631e
Mentioned general case metrics
nastasha-solomon ccf0a44
Update docs/detections/alerts-ui-manage.asciidoc
nastasha-solomon bfe13cc
Update docs/detections/alerts-ui-manage.asciidoc
nastasha-solomon 3e79965
Update docs/detections/alerts-ui-manage.asciidoc
nastasha-solomon 2e7e987
Update docs/detections/alerts-ui-manage.asciidoc
nastasha-solomon ac99e91
Update docs/cases/cases-manage.asciidoc
nastasha-solomon 1e1c7b3
Update docs/cases/cases-manage.asciidoc
nastasha-solomon bf15606
Update docs/cases/cases-manage.asciidoc
nastasha-solomon d226d9e
Update docs/detections/alerts-ui-manage.asciidoc
nastasha-solomon a645db3
Update docs/cases/cases-manage.asciidoc
nastasha-solomon 15fe6a9
First batch
nastasha-solomon f99b7f5
Merge branch 'case-enhancements-8.3' of github.com:elastic/security-d…
nastasha-solomon 189ec22
Update docs/cases/cases-manage.asciidoc
nastasha-solomon 1fe542b
Update docs/cases/cases-manage.asciidoc
nastasha-solomon aad4c6a
Update docs/cases/cases-manage.asciidoc
nastasha-solomon 6b4a3c2
Update docs/cases/cases-manage.asciidoc
nastasha-solomon c8743c0
Update docs/cases/cases-manage.asciidoc
nastasha-solomon 25d045c
Second batch
nastasha-solomon 14734a1
Merge branch 'main' into case-enhancements-8.3
nastasha-solomon 232b38a
Update docs/detections/alerts-ui-manage.asciidoc
nastasha-solomon 5fb391f
Update docs/cases/cases-manage.asciidoc
nastasha-solomon b6f5e6d
Update docs/cases/cases-manage.asciidoc
nastasha-solomon 0341fdc
Update docs/cases/cases-manage.asciidoc
nastasha-solomon 84f054d
Update docs/cases/cases-manage.asciidoc
nastasha-solomon 58afb5e
Update docs/cases/cases-manage.asciidoc
nastasha-solomon 61897ba
Update docs/cases/cases-manage.asciidoc
nastasha-solomon d4a60fb
Update docs/cases/cases-manage.asciidoc
nastasha-solomon 7d92b0b
Update docs/cases/cases-manage.asciidoc
nastasha-solomon d289d4f
Update docs/cases/cases-overview.asciidoc
nastasha-solomon 316c73a
Update docs/cases/cases-ui-integrations.asciidoc
nastasha-solomon e963cb4
Update docs/cases/cases-manage.asciidoc
nastasha-solomon a78d7e2
Janeen's suggestion
nastasha-solomon c06ead0
Merge branch 'main' into case-enhancements-8.3
nastasha-solomon cdfbe45
Merge branch 'main' into case-enhancements-8.3
nastasha-solomon 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
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 |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| include::cases-overview.asciidoc[leveloffset=+1] | ||
|
|
||
| include::cases-manage.asciidoc[leveloffset=+2] | ||
|
|
||
| include::cases-ui-integrations.asciidoc[] |
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,180 @@ | ||
| [[cases-open-manage]] | ||
| = Open and manage cases | ||
|
|
||
| You can create and manage cases using the UI or the <<cases-api-overview>>. | ||
|
|
||
| [float] | ||
| [[cases-ui-open]] | ||
| == Open a new case | ||
|
|
||
| Open a new case to keep track of security issues and share their details with | ||
| colleagues. | ||
|
|
||
| . Go to *Investigate* -> *Cases*, then click *Create case*. If no cases exist, the Cases table will be empty and you'll be prompted to create one by clicking the *Create case* button inside the table. | ||
nastasha-solomon marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| . Give the case a name, add relevant tags, assign a severity level, and provide a description. You can use | ||
| https://www.markdownguide.org/cheat-sheet[Markdown] syntax in the case description. | ||
| + | ||
| NOTE: If you do not assign your case a severity level, it will be assigned *Low* by default. | ||
|
|
||
| + | ||
| TIP: You can insert a Timeline link in the case description by clicking the Timeline icon (image:images/add-timeline-button.png[Timeline icon,17,17]). | ||
|
|
||
| . Choose if you want alert statuses to sync with the case's status after they are added to the case. This option is enabled by default, but you can turn it off after creating the case. | ||
| . From *External incident management*, select a <<cases-ui-integrations, connector>>. If you’ve previously added one, that connector displays as the default selection. Otherwise, the default setting is `No connector selected`. | ||
nastasha-solomon marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| . Click *Create case*. | ||
| + | ||
| NOTE: If you've selected a connector for the case, the case is automatically pushed to the third-party system it's connected to. | ||
|
|
||
|
|
||
| [role="screenshot"] | ||
| image::images/cases-ui-open.png[Shows an open case] | ||
|
|
||
| [float] | ||
| [[cases-ui-manage]] | ||
| == Manage existing cases | ||
|
|
||
| From the Cases page, you can search existing cases and filter them by severity, tags, reporter, and status: `Open`, `In progress`, or `Closed`. General case metrics, including how long it takes to close cases, are provided above the table. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/cases-home-page.png[Case UI Home] | ||
|
|
||
| To explore a case, click on its name. You can then: | ||
|
|
||
| * <<cases-summary>> | ||
| * Add and <<cases-manage-comments, manage comments>> | ||
| + | ||
| TIP: Comments can contain Markdown. For syntax help, click the Markdown icon (image:images/markdown-icon.png[Click markdown icon,17,17]) in the bottom right of the comment. | ||
|
|
||
| * <<cases-examine-alerts, Examine alerts attached to the case>> | ||
| * <<cases-lens-visualization>> | ||
| * Modify the case's description | ||
| * <<cases-ui-integrations, Manage connectors>> and send updates to external systems (if you've added a connector to the case) | ||
| * Close the case or reopen it | ||
| * Edit tags | ||
| * Update the case's severity | ||
| * Refresh the case to retrieve the latest updates | ||
|
|
||
| [float] | ||
| [[cases-summary]] | ||
| === Review the case summary | ||
|
|
||
| Click on an existing case to access its summary. The case summary, located under the case title, contains metrics that summarize alert information and response times. These metrics update when you attach additional unique alerts to the case, add connectors, or modify the case's status: | ||
|
|
||
| * **Total alerts**: Total number of unique alerts attached to the case | ||
| * **Associated users**: Total number of unique users that are represented in the attached alerts | ||
| * **Associated hosts**: Total number of unique hosts that are represented in the attached alerts | ||
| * **Total connectors**: Total number of connectors that have been added to the case | ||
| * **Case created**: Date and time that the case was created | ||
| * **Open duration**: Time elapsed since the case was created | ||
| * **In progress duration**: How long the case has been in the `In progress` state | ||
| * **Duration from creation to close**: Time elapsed from when the case was created to when it was closed | ||
|
|
||
| [role="screenshot"] | ||
| image::images/cases-summary.png[Shows you a summary of the case] | ||
|
|
||
| [float] | ||
| [[cases-manage-comments]] | ||
| === Manage case comments | ||
| To edit, delete, or quote a comment, select the appropriate option from the *More actions* menu (*…*). | ||
|
|
||
| [role="screenshot"] | ||
| image::images/cases-manage-comments.png[Shows you a summary of the case] | ||
|
|
||
| [float] | ||
| [[cases-examine-alerts]] | ||
| === Examine alerts attached to a case | ||
|
|
||
| preview::[] | ||
|
|
||
| To explore the alerts attached to a case, click the *Alerts* tab. In the table, alerts are organized from oldest to newest. To <<view-alert-details, view alert details>>, click the *View details* button. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/cases-alert-tab.png[Shows you the Alerts tab] | ||
|
|
||
| [float] | ||
| [[cases-lens-visualization]] | ||
| === Add a Lens visualization | ||
|
|
||
| beta[] | ||
|
|
||
| Add a Lens visualization to your case to portray event and alert data through charts and graphs. | ||
nastasha-solomon marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| [role="screenshot"] | ||
| image::images/add-vis-to-case.gif[Shows how to add a visualization to a case] | ||
nastasha-solomon marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| To add a Lens visualization to a comment within your case: | ||
|
|
||
| . Click the *Visualization* button. The **Add visualization** dialog appears. | ||
| . Select an existing visualization from your Visualize Library or create a new visualization. | ||
|
|
||
| + | ||
|
|
||
| IMPORTANT: Set an absolute time range for your visualization. This ensures your visualization doesn't change over time after you save it to your case, and provides important context for others managing the case. | ||
nastasha-solomon marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| + | ||
| . Save the visualization to your Visualize Library by clicking the *Save to library* button (optional). | ||
| .. Enter a title and description for the visualization. | ||
| .. Choose if you want to keep the *Update panel on Security* activated. This option is activated by default and automatically adds the visualization to your Visualize Library. | ||
| . After you've finished creating your visualization, click *Save and return* to go back to your case. | ||
| . Click *Preview* to show how the visualization will appear in the case comment. | ||
| . Click *Add Comment* to add the visualization to your case. | ||
|
|
||
| NOTE: Once a visualization has been added to a case, it cannot be modified or deleted. However, you can interact with the visualization by clicking the *Open Visualization* option in the comment menu. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/cases-open-vis.png[Shows where the Open Visualization option is] | ||
|
|
||
| [float] | ||
| [[cases-export-import]] | ||
| == Export and import cases | ||
|
|
||
| Cases can be <<cases-export, exported>> and <<cases-import, imported>> as saved objects using the {kib} {kibana-ref}/managing-saved-objects.html[Saved Objects] UI. | ||
|
|
||
| IMPORTANT: Before importing Lens visualizations, Timelines, or alerts into a space, ensure their data is present. Without it, they won't work after being imported. | ||
|
|
||
| [float] | ||
| [[cases-export]] | ||
| === Export a case | ||
| Use the *Export* option to move cases between different Kibana instances. When you export a case, the following data is exported to a newline-delimited JSON (`.ndjson`) file: | ||
|
|
||
| * Case details | ||
| * User actions | ||
| * Text string comments | ||
| * Case alerts | ||
| * Lens visualizations (exported as JSON blobs). | ||
|
|
||
| To export a case: | ||
|
|
||
| . Open the main menu, go to *Stack Management -> {kib}*, then select the *Saved Objects* tab. | ||
| . Search for the case by choosing a saved object type or entering the case title in the search bar. | ||
| . Select one or more cases, then click the *Export* button. | ||
| . Click *Export*. A confirmation message that your file is downloading displays. | ||
nastasha-solomon marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| + | ||
| TIP: Keep the *Include related objects* option enabled to ensure connectors are exported too. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/cases-export-button.png[Shows the export saved objects workflow] | ||
|
|
||
| [float] | ||
| [[cases-import]] | ||
| === Import a case | ||
|
|
||
| To import a case: | ||
|
|
||
| . Open the main menu, go to *Stack Management -> {kib}*, then select the *Saved Objects* tab. | ||
| . Click *Import*. | ||
| . Select the NDJSON file containing the exported case and configure the import options. | ||
| . Click *Import*. | ||
| . Review the import log and click *Done*. | ||
| + | ||
| [IMPORTANT] | ||
| ========================= | ||
|
|
||
| Be mindful of the following: | ||
|
|
||
| * If the imported case had connectors attached to it, you'll be prompted to re-authenticate the connectors. To do so, click *Go to connectors* on the *Import saved objects* flyout and complete the necessary steps. Alternatively, open the main menu, then go to *Stack Management -> Alerts and Insights -> Rules and Connectors -> Connectors* to access connectors. | ||
| * If the imported case had attached alerts, verify that the alerts’ source documents exist in the environment. Case features that interact with alerts (such as the Alert details flyout and rule details page) rely on the alerts’ source documents to function. | ||
|
|
||
| ========================= | ||
| + | ||
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.