-
Notifications
You must be signed in to change notification settings - Fork 150
[ResponseOps][Cases][9.2 & Serverless] New case analytics indices 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
28
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 10 commits
Commits
Show all changes
28 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 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,58 @@ | ||
--- | ||
applies_to: | ||
stack: ga | ||
serverless: ga | ||
products: | ||
- id: kibana | ||
--- | ||
|
||
# Visualize case data [visualize-case-data] | ||
|
||
Case data is stored in case analytics indices, which include data from case comments, attachments, and activity. You can query this information to build dashboards and metrics that improve your visibility into case patterns and trends. | ||
nastasha-solomon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## About case analytics indices [about-case-analytics-indices] | ||
|
||
Case analytics indices and their aliases are automatically generated when Kibana starts up. Every five minutes, the indices are updated with new data from cases in your space. Historical data about cases is not stored; it gets overwritten whenever new case data is written to the indices. | ||
nastasha-solomon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
You can begin querying case analytics indices as soon as you have cases in your space. To learn more about fields in the indices, refer to | ||
nastasha-solomon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
% [Case analytics indices schema](kibana://reference/case-analytics-indices-schema.md) | ||
|
||
|
||
| Index | Alias | Description | | ||
| ---------------------------- | ---------------------- |----------------------------------------- | | ||
| `.internal.cases` | `.cases` | Stores general data related to cases. | | ||
| `.internal.cases-comments` | `.cases-comments` | Stores data related to case comments. | | ||
| `.internal.cases-activity` | `.cases-activity` | Stores data related to case activity. | | ||
| `.internal.cases-attachments`| `.cases-attachments` | Stores data related to case attachments (only alerts and files added to the case). | | ||
nastasha-solomon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## Explore case data [explore-case-analytics-indices] | ||
|
||
::::{admonition} Requirements | ||
To query the case analytics indices, your role must have at least `Read` and `view_index_metadata` access to the 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 cases that are currently open: | ||
```console | ||
FROM .internal.cases | STATS count = COUNT(*) BY status | WHERE status == "open" | ||
nastasha-solomon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
``` | ||
|
||
* Find the total number of cases that are currently in progress: | ||
```console | ||
FROM .internal.cases | STATS count = COUNT(*) BY status | WHERE status == "in-progress" | ||
``` | ||
|
||
* Find the total number of cases that are closed: | ||
```console | ||
FROM .internal.cases | STATS count = COUNT(*) BY status | WHERE status == "closed" | ||
``` | ||
|
||
* Find cases that are open and sort them by time, with the most recent is at the top: | ||
nastasha-solomon marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
```console | ||
FROM .internal.cases | WHERE status == "open" | SORT created_at DESC | ||
``` | ||
|
||
* Find the average time that it takes to close a case: | ||
```console | ||
FROM .internal.cases | STATS average_time_to_close = AVG(time_to_resolve) | ||
``` |
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.