Skip to content

Commit 75018ff

Browse files
cleanup
1 parent 7158d17 commit 75018ff

File tree

1 file changed

+20
-21
lines changed

1 file changed

+20
-21
lines changed

explore-analyze/alerts-cases/cases/cases-as-data.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ applies_to:
99

1010
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.
1111

12+
::::{admonition} Requirements
13+
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.
14+
::::
15+
1216
## Turn on cases as data [turn-on-cases-as-data]
1317

1418
To turn on cases as data, add `xpack.cases.incrementalId.enabled: true` to your [`kibana.yml`](/deploy-manage/stack-settings.md) file.
@@ -19,31 +23,26 @@ To turn on cases as data, add `xpack.cases.incrementalId.enabled: true` to your
1923

2024
## Create and manage indices for case data [create-manage-case-analytics-indices]
2125

22-
After turning on cases as data, you do not need to manually create the analytics indices. {{es}} automatically creates the indices in any space with cases and for each solution ({{stack-manage-app}}, {{observability}}, and Security cases). To form the analytics indices, it indexes general data about cases and data related to case comments, attachments, and activity.
26+
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.
2327

24-
You also do not need to manually manage the analytics indices' index lifecycle management (ILM) policies. The indices are updated by a background task that runs every five minutes and applies a snapshot of the most current cases data. Note that historical case data is not retained; it gets overwritten whenever the indices are refreshed.
28+
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.
2529

2630
::::{note}
27-
There may be delays in indexing data and creating indices:
2831
- After making new cases, it may take up to 10 minutes to index the new case data.
2932
- After making a new space, it can take up to an hour for the case analytics indices for that space to form.
3033
::::
3134

32-
## Explore case data [explore-case-data]
35+
## Grant access to case analytics indices [case-analytics-indices-privs]
3336

34-
::::{admonition} Requirements
35-
* Your role needs at least `read` and `view_index_metadata` access to the appropriate case analytics indices.
36-
* 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.
37-
::::
37+
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).
3838

39-
To explore case data:
39+
## Explore and visualize case data with Discover [explore-case-data]
4040

41-
1. Create a [data view](../../../explore-analyze/find-and-organize/data-views.md) that uses any of the case analytics indices.
42-
2. Search and filter the case data in [Discover](../../discover.md) or build visualizations for dashboards in [Lens](../../visualize/lens.md).
41+
By default, {{kib}} requires a [{{data-source}}](../../find-and-organize/data-views.md) to access your Elasticsearch data. When creating a {{data-source}} for case data, point to one or more [case analytics indices or their aliases](../../../explore-analyze/alerts-cases/cases/cases-as-data.md#case-analytics-indices-names).
4342

44-
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.
43+
You can also [try {{esql}}](../../../explore-analyze/discover/try-esql.md), that lets you query any data you have in {{es}} without specifying a {{data-source}} first. Here are some sample queries to get you started:
4544

46-
* Find the total number of open cases in the default space:
45+
* Find the total number of open {{observability}} cases in the default space:
4746

4847
```console
4948
FROM .internal.cases.default-observability | STATS count = COUNT(*) BY status | WHERE status == "open"
@@ -75,14 +74,14 @@ To help you start visualizing your case data, here are some sample {{esql}} quer
7574

7675
## Case analytics indices names and aliases [case-analytics-indices-names]
7776

78-
This section provides the names and aliases of the case analytics indices that {{es}} creates per space and solution. Note that `<space-name>` is a placeholder for the name of a space.
77+
{{es}} automatically creates the following case analytics indices and their aliases in spaces with case data.
7978

8079
::::{note}
8180
Go to
8281
% [Case analytics indices schema](kibana://reference/case-analytics-indices-schema.md) for schema details.
8382
::::
8483

85-
### Indices for general case data
84+
### General case data
8685

8786
These indices store general data about cases.
8887

@@ -92,29 +91,29 @@ These indices store general data about cases.
9291
| `.internal.cases.<space-name>-observability` | `.cases.<space-name>-observability` | {{observability}} cases |
9392
| `.internal.cases.<space-name>-securitysolution` | `.cases.<space-name>-securitysolution` | Security cases |
9493

95-
### Indices for case comments
94+
### Case comments
9695

97-
These indices store data related to comments in Stack Management, {{observability}}, and Security cases.
96+
These indices store data related to comments.
9897

9998
| Index | Alias | Created for |
10099
| ---------------------------- | ---------------------- |----------------------------------------- |
101100
| `.internal.cases-comments.<space-name>-cases` | `.cases-comments.<space-name>-cases` | Stack Management cases |
102101
| `.internal.cases-comments.<space-name>-observability` | `.cases-comments.<space-name>-observability` | {{observability}} cases |
103102
| `.internal.cases-comments.<space-name>-securitysolution` | `.cases-comments.<space-name>-securitysolution` | Security cases |
104103

105-
### Indices for case attachments
104+
### Case attachments
106105

107-
These indices store data related to attachments in Stack Management, {{observability}}, and Security cases.
106+
These indices store data related to attachments.
108107

109108
| Index | Alias | Created for |
110109
| ---------------------------- | ---------------------- |----------------------------------------- |
111110
| `.internal.cases-attachments.<space-name>-cases` | `.cases-attachments.<space-name>-cases` | Stack Management cases |
112111
| `.internal.cases-attachments.<space-name>-observability` | `.cases-attachments.<space-name>-observability` | {{observability}} cases |
113112
| `.internal.cases-attachments.<space-name>-securitysolution` | `.cases-attachments.<space-name>-securitysolution` | Security cases |
114113

115-
### Indices for case activity
114+
### Case activity
116115

117-
These indices store data related to activity in Stack Management, {{observability}}, and Security cases.
116+
These indices store data related to activity.
118117

119118
| Index | Alias | Created for |
120119
| ---------------------------- | ---------------------- |----------------------------------------- |

0 commit comments

Comments
 (0)