-
Notifications
You must be signed in to change notification settings - Fork 159
[Cases][9.2 & Serverless] Cases as data feature docs #2220
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
Open
nastasha-solomon
wants to merge
53
commits into
main
Choose a base branch
from
case-analytics-indices-9.1-serv
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 28 commits
Commits
Show all changes
53 commits
Select commit
Hold shift + click to select a range
6ac2538
First draft
nastasha-solomon b746055
Removed extra spaces
nastasha-solomon e5b0dbe
Merge branch 'main' into case-analytics-indices-9.1-serv
nastasha-solomon 18342d1
Updates sec and obs docs
nastasha-solomon f5a6e4c
Applies to tags
nastasha-solomon 1e574b1
Added ref to kibana page
nastasha-solomon e6f473b
Fix error
nastasha-solomon b02b1b3
fix for real this time (i hope)
nastasha-solomon 2addac7
minor fixes
nastasha-solomon c9f5724
the to from
nastasha-solomon 52325f6
Update explore-analyze/alerts-cases/cases/visualize-case-data.md
nastasha-solomon a881129
Merge branch 'main' into case-analytics-indices-9.1-serv
nastasha-solomon 102669a
Merge branch 'main' into case-analytics-indices-9.1-serv
nastasha-solomon 4355559
Update explore-analyze/alerts-cases/cases/visualize-case-data.md
nastasha-solomon 2533c13
Update explore-analyze/alerts-cases/cases/visualize-case-data.md
nastasha-solomon c50b531
Merge branch 'main' into case-analytics-indices-9.1-serv
nastasha-solomon 37b8a1b
Merge branch 'main' into case-analytics-indices-9.1-serv
nastasha-solomon fd9b185
Merge branch 'main' into case-analytics-indices-9.1-serv
nastasha-solomon 5c0496a
Merge branch 'main' into case-analytics-indices-9.1-serv
nastasha-solomon 620724c
Merge branch 'main' into case-analytics-indices-9.1-serv
nastasha-solomon 4e16729
Merge branch 'main' into case-analytics-indices-9.1-serv
nastasha-solomon 5b720d1
Merge branch 'main' into case-analytics-indices-9.1-serv
nastasha-solomon 754575f
Technical input
nastasha-solomon 07777e6
Fix table
nastasha-solomon 0f063b2
removed some duplicate information
nastasha-solomon 7ad4c2b
Reformats table
nastasha-solomon b6a80a3
Moves more content
nastasha-solomon dc46973
Merge branch 'main' into case-analytics-indices-9.1-serv
nastasha-solomon a49dd72
Apply suggestion from @nastasha-solomon
nastasha-solomon 1765614
adds some content from toi
nastasha-solomon 178e51d
fix conflict
nastasha-solomon 53aeeef
bye
nastasha-solomon 43a1eb5
try again
nastasha-solomon f830cbf
Apply suggestion from @nastasha-solomon
nastasha-solomon 4eb307a
small change
nastasha-solomon 1e5cddb
Merge branch 'case-analytics-indices-9.1-serv' of https://github.com/…
nastasha-solomon 7158d17
removed attribute
nastasha-solomon 75018ff
cleanup
nastasha-solomon 604fd8e
Removed space
nastasha-solomon 92ba0cf
Adding info about dataviews
nastasha-solomon 7bca4b7
Merge branch 'main' into case-analytics-indices-9.1-serv
nastasha-solomon 33ee601
Merge branch 'main' into case-analytics-indices-9.1-serv
nastasha-solomon 86e01b0
Update explore-analyze/alerts-cases/cases.md
nastasha-solomon 99720b9
Update explore-analyze/alerts-cases/cases/cases-as-data.md
nastasha-solomon 2d9fdb3
Update explore-analyze/alerts-cases/cases/cases-as-data.md
nastasha-solomon 80c452b
Merge branch 'main' into case-analytics-indices-9.1-serv
nastasha-solomon bcf78ea
Updated index names
nastasha-solomon a8ee408
Merge branch 'case-analytics-indices-9.1-serv' of https://github.com/…
nastasha-solomon bdd9dd5
Updating applies to
nastasha-solomon 289392b
adding to applies to tags
nastasha-solomon dbb2de6
Merge branch 'main' into case-analytics-indices-9.1-serv
nastasha-solomon 41484f5
Apply suggestion from @nastasha-solomon
nastasha-solomon b95b54c
Merge branch 'main' into case-analytics-indices-9.1-serv
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
112 changes: 112 additions & 0 deletions
112
explore-analyze/alerts-cases/cases/visualize-case-data.md
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,112 @@ | ||
--- | ||
applies_to: | ||
stack: ga 9.2 | ||
serverless: ga | ||
products: | ||
- id: kibana | ||
--- | ||
|
||
# Visualize case data [visualize-case-data] | ||
|
||
Case data, such as details about comments, activities, and attachments, is collected in case analytics indices. You can query these indices to build dashboards and metrics that improve your visibility into case patterns and trends. | ||
|
||
::::{admonition} Requirements | ||
|
||
To visualize case data, you must do the following: | ||
|
||
* {applies_to}`stack: ga` Turn on the case analytics indices feature by adding `xpack.cases.incrementalId.enabled: true` to your [`kibana.yml`](/deploy-manage/stack-settings.md) file. | ||
* Ensure your role has at least `read` and `view_index_metadata` access to the appropriate case anlaytics indices. | ||
* (Optional) If you don't have cases, create a new one in a {{kib}} space to automatically generate the case analytics indices. | ||
|
||
:::: | ||
|
||
## About case analytics indices [about-case-analytics-indices] | ||
|
||
After you turn on the case analytics indices feature, your {{kib}} spaces are checked for case data. If they have any, {{es}} automatically creates case analytics indices for each solution (Stack Management, {{observability}}, and Security) and every {{kib}} space. Aliases for the case analytics indices are automatically created as well. | ||
nastasha-solomon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
The case analytics indices are updated very five minutes with a snapshot of most current cases data in your spaces. Historical data for cases is not stored; it gets overwritten whenever the indices are refreshed. | ||
|
||
::::{note} | ||
It may take up to an hour for case analytics indices to form in a new {{kib}} space. | ||
:::: | ||
|
||
### General case data | ||
|
||
These indices store general data related to cases created in Stack Management, {{observability}}, and Security. | ||
|
||
| Index | Alias | Created for | | ||
| ---------------------------- | ---------------------- |----------------------------------------- | | ||
| `.internal.cases.<space-name>-cases` | `.cases.<space-name>-cases` | Stack Management cases | | ||
| `.internal.cases.<space-name>-observability` | `.cases.<space-name>-observability` | {{observability}} cases | | ||
| `.internal.cases.<space-name>-securitysolution` | `.cases.<space-name>-securitysolution` | Security cases | | ||
|
||
### Case comments | ||
|
||
These indices store data related to comments in Stack Management, {{observability}}, and Security cases. | ||
|
||
| Index | Alias | Created for | | ||
| ---------------------------- | ---------------------- |----------------------------------------- | | ||
| `.internal.cases-comments.<space-name>-cases` | `.cases-comments.<space-name>-cases` | Stack Management cases | | ||
| `.internal.cases-comments.<space-name>-observability` | `.cases-comments.<space-name>-observability` | {{observability}} cases | | ||
| `.internal.cases-comments.<space-name>-securitysolution` | `.cases-comments.<space-name>-securitysolution` | Security cases | | ||
|
||
|
||
### Case attachments | ||
|
||
These indices store data related to attachments in Stack Management, {{observability}}, and Security cases. | ||
|
||
| Index | Alias | Created for | | ||
| ---------------------------- | ---------------------- |----------------------------------------- | | ||
| `.internal.cases-attachments.<space-name>-cases` | `.cases-attachments.<space-name>-cases` | Stack Management cases | | ||
| `.internal.cases-attachments.<space-name>-observability` | `.cases-attachments.<space-name>-observability` | {{observability}} cases | | ||
| `.internal.cases-attachments.<space-name>-securitysolution` | `.cases-attachments.<space-name>-securitysolution` | Security cases | | ||
|
||
### Case activity | ||
|
||
These indices store data related to activity in Stack Management, {{observability}}, and Security cases. | ||
|
||
| Index | Alias | Created for | | ||
| ---------------------------- | ---------------------- |----------------------------------------- | | ||
| `.internal.cases-activity.<space-name>-cases` | `.cases-activity.<space-name>-cases` | Stack Management cases | | ||
| `.internal.cases-activity.<space-name>-observability` | `.cases-activity.<space-name>-observability` | {{observability}} cases | | ||
| `.internal.cases-activity.<space-name>-securitysolution` | `.cases-activity.<space-name>-securitysolution` | Security cases | | ||
|
||
|
||
## Explore case data [explore-case-analytics-indices] | ||
|
||
Search and filter case data in [Discover](../../discover.md) and [Lens](../../visualize/lens.md), and build visualizations for [dashboards](../../dashboards.md). To help you start visualizing your case data, here are some sample {{esql}} queries that you can run from the [{{esql}} editor](../../../explore-analyze/query-filter/languages/esql-kibana.md#esql-kibana-get-started) in Discover. | ||
|
||
* Find the total number of open cases in the default {{kib}} space: | ||
|
||
```console | ||
FROM .internal.cases.default-observability | STATS count = COUNT(*) BY status | WHERE status == "open" | ||
``` | ||
|
||
* Find the total number of in progress Stack Management cases in the default {{kib}} space: | ||
|
||
```console | ||
FROM .internal.cases.default-cases | STATS count = COUNT(*) BY status | WHERE status == "in-progress" | ||
``` | ||
|
||
* Find the total number of closed {{observability}} cases in the default {{kib}} space: | ||
|
||
```console | ||
FROM .internal.cases.default-observability | STATS count = COUNT(*) BY status | WHERE status == "closed" | ||
``` | ||
|
||
* Find Security cases that are open in the default {{kib}} space, and sort them by time, with the most recent at the top: | ||
|
||
```console | ||
FROM .internal.cases.default-securitysolution | WHERE status == "open" | SORT created_at DESC | ||
``` | ||
|
||
* Find the average time that it takes to close Security cases in the default {{kib}} space: | ||
|
||
```console | ||
FROM .internal.cases.default-securitysolution | STATS average_time_to_close = AVG(time_to_resolve) | ||
``` | ||
|
||
::::{tip} | ||
To learn more about queryable fields in the indices, refer to | ||
% [Case analytics indices schema](kibana://reference/case-analytics-indices-schema.md) | ||
:::: |
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
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.