-
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 all 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
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,126 @@ | ||
--- | ||
applies_to: | ||
stack: preview 9.2 | ||
serverless: unavailable | ||
--- | ||
|
||
# Use cases as data [use-cases-as-data] | ||
|
||
The cases as data feature lets you visualize data about cases in your [space](/deploy-manage/manage-spaces.md). After turning it on, you can query case data from dedicated case analytics indices and build dashboards and visualizations to track case trends and operational metrics. This information is particularly useful when reporting on key performance indicators (KPIs) such as Mean Time To Respond (MTTR), case severity trends, and analyst workload. | ||
|
||
::::{admonition} Requirements | ||
To use cases as data, you must have the appropriate subscription. Refer to the subscription page for [Elastic Cloud](https://www.elastic.co/subscriptions/cloud) and [Elastic Stack/self-managed](https://www.elastic.co/subscriptions) for the breakdown of available features and their associated subscription tiers. | ||
:::: | ||
|
||
## Turn on cases as data [turn-on-cases-as-data] | ||
|
||
To turn on cases as data, add `xpack.cases.incrementalId.enabled: true` to your [`kibana.yml`](/deploy-manage/stack-settings.md) file. | ||
|
||
::::{warning} | ||
We only recommend turning this feature on if your deployment has 10 or fewer spaces with cases. The background tasks that refresh the case analytics indices in each space are run every five minutes and may overload Task Manager. | ||
:::: | ||
|
||
## Create and manage indices for case data [create-manage-case-analytics-indices] | ||
|
||
After turning on cases as data, you do not need to manually create the analytics indices. {{es}} will automatically create them for you in any space with cases and for each solution ({{stack-manage-app}}, {{observability}}, and Security). The indices are populated with general case data as well as data related to case comments, attachments, and activity. | ||
|
||
You also do not need to manually manage the lifecycle policies of the analytics indices. Every five minutes, a background task runs to refresh the indices with a snapshot of the most current cases data. During the refresh, historical case data is overwritten. | ||
|
||
::::{note} | ||
- After making new cases, it may take up to 10 minutes to index the new case data. | ||
- After making a new space, it can take up to an hour for the case analytics indices for that space to form. | ||
:::: | ||
|
||
## Grant access to case analytics indices [case-analytics-indices-privs] | ||
|
||
Ensure your role has at least `read` and `view_index_metadata` access to the appropriate [case analytics indices](../../../explore-analyze/alerts-cases/cases/cases-as-data.md#case-analytics-indices-names). | ||
|
||
## Explore case data with Discover and Lens [explore-case-data] | ||
|
||
Use [Discover](../../discover.md) and [Lens](../../visualize/lens.md) to search and filter your case data and display your findings in visualizations. | ||
|
||
To get started, create a [{{data-source}}](../../find-and-organize/data-views.md) that points to one or more [case analytics indices or their aliases](../../../explore-analyze/alerts-cases/cases/cases-as-data.md#case-analytics-indices-names). To point to all case analytics indices in your space, use the `.internal.cases*` index pattern. | ||
|
||
::::{note} | ||
Case data is stored in hidden indices. You can display hidden indices by selecting **Show advanced settings**, then turning on **Allow hidden and system indices**. | ||
:::: | ||
|
||
You can also interact with your case data using [{{esql}} in Discover](../../../explore-analyze/discover/try-esql.md). Here are some sample queries to get you started: | ||
|
||
* Find the total number of open {{observability}} cases in the default space: | ||
|
||
```console | ||
FROM .internal.cases.observability-default | STATS count = COUNT(*) BY status | WHERE status == "open" | ||
``` | ||
|
||
* Find the total number of in progress Stack Management cases in the default space: | ||
|
||
```console | ||
FROM .internal.cases.cases-default | STATS count = COUNT(*) BY status | WHERE status == "in-progress" | ||
``` | ||
|
||
* Find the total number of closed {{observability}} cases in the default space: | ||
|
||
```console | ||
FROM .internal.cases.observability-default | STATS count = COUNT(*) BY status | WHERE status == "closed" | ||
``` | ||
|
||
* Find Security cases that are open in the default space, and sort them by time, with the most recent at the top: | ||
|
||
```console | ||
FROM .internal.cases.securitysolution-default | WHERE status == "open" | SORT created_at DESC | ||
``` | ||
|
||
* Find the average time that it takes to close Security cases in the default space: | ||
|
||
```console | ||
FROM .internal.cases.securitysolution-default | STATS average_time_to_close = AVG(time_to_resolve) | ||
``` | ||
|
||
## Case analytics indices names and aliases [case-analytics-indices-names] | ||
|
||
{{es}} automatically creates the following case analytics indices and their aliases in spaces with case data. | ||
|
||
% ::::{note} | ||
% Go to [Case analytics indices schema](kibana://reference/case-analytics-indices-schema.md) for schema details. | ||
% :::: | ||
|
||
### General case data | ||
|
||
These indices store general data about cases. | ||
|
||
| Index | Alias | Created for | | ||
| ---------------------------- | ---------------------- |----------------------------------------- | | ||
| `.internal.cases.cases-<space-name>` | `.cases.cases-<space-name>` | Stack Management cases | | ||
| `.internal.cases.observability-<space-name>` | `.cases.observability-<space-name>` | {{observability}} cases | | ||
| `.internal.cases.securitysolution-<space-name>` | `.cases.securitysolution-<space-name>` | Security cases | | ||
|
||
### Case comments | ||
|
||
These indices store data related to comments. | ||
|
||
| Index | Alias | Created for | | ||
| ---------------------------- | ---------------------- |----------------------------------------- | | ||
| `.internal.cases-comments.cases-<space-name>` | `.cases-comments.cases-<space-name>` | Stack Management cases | | ||
| `.internal.cases-comments.observability-<space-name>` | `.cases-comments.observability-<space-name>` | {{observability}} cases | | ||
| `.internal.cases-comments.securitysolution-<space-name>` | `.cases-comments.securitysolution-<space-name>` | Security cases | | ||
|
||
### Case attachments | ||
|
||
These indices store data related to attachments. | ||
|
||
| Index | Alias | Created for | | ||
| ---------------------------- | ---------------------- |----------------------------------------- | | ||
| `.internal.cases-attachments.cases-<space-name>` | `.cases-attachments.cases-<space-name>` | Stack Management cases | | ||
| `.internal.cases-attachments.observability-<space-name>` | `.cases-attachments.observability-<space-name>` | {{observability}} cases | | ||
| `.internal.cases-attachments.securitysolution-<space-name>` | `.cases-attachments.securitysolution-<space-name>` | Security cases | | ||
|
||
### Case activity | ||
|
||
These indices store data related to activity. | ||
|
||
| Index | Alias | Created for | | ||
| ---------------------------- | ---------------------- |----------------------------------------- | | ||
| `.internal.cases-activity.cases-<space-name>` | `.cases-activity.cases-<space-name>` | Stack Management cases | | ||
| `.internal.cases-activity.observability-<space-name>` | `.cases-activity.observability-<space-name>` | {{observability}} cases | | ||
| `.internal.cases-activity.securitysolution-<space-name>` | `.cases-activity.securitysolution-<space-name>` | Security cases | |
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
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.