|
| 1 | +--- |
| 2 | +applies_to: |
| 3 | + stack: preview 9.2 |
| 4 | + serverless: unavailable |
| 5 | +--- |
| 6 | + |
| 7 | +# Use cases as data [use-cases-as-data] |
| 8 | + |
| 9 | +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. |
| 10 | + |
| 11 | +::::{admonition} Requirements |
| 12 | +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. |
| 13 | +:::: |
| 14 | + |
| 15 | +## Turn on cases as data [turn-on-cases-as-data] |
| 16 | + |
| 17 | +To turn on cases as data, add `xpack.cases.analytics.index.enabled: true` to your [`kibana.yml`](/deploy-manage/stack-settings.md) file. |
| 18 | + |
| 19 | +::::{warning} |
| 20 | +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. |
| 21 | +:::: |
| 22 | + |
| 23 | +## Create and manage indices for case data [create-manage-case-analytics-indices] |
| 24 | + |
| 25 | +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. |
| 26 | + |
| 27 | +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. |
| 28 | + |
| 29 | +::::{note} |
| 30 | +- After making new cases, it may take up to 10 minutes to index the new case data. |
| 31 | +- After making a new space, it can take up to an hour for the case analytics indices for that space to form. |
| 32 | +:::: |
| 33 | + |
| 34 | +## Grant access to case analytics indices [case-analytics-indices-privs] |
| 35 | + |
| 36 | +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). |
| 37 | + |
| 38 | +## Explore case data with Discover and Lens [explore-case-data] |
| 39 | + |
| 40 | +Use [Discover](../../discover.md) and [Lens](../../visualize/lens.md) to search and filter your case data and display your findings in visualizations. |
| 41 | + |
| 42 | +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. |
| 43 | + |
| 44 | +::::{note} |
| 45 | +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**. |
| 46 | +:::: |
| 47 | + |
| 48 | +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: |
| 49 | + |
| 50 | +* Find the total number of open {{observability}} cases in the default space: |
| 51 | + |
| 52 | + ```console |
| 53 | + FROM .internal.cases.observability-default | STATS count = COUNT(*) BY status | WHERE status == "open" |
| 54 | + ``` |
| 55 | + |
| 56 | +* Find the total number of in progress Stack Management cases in the default space: |
| 57 | + |
| 58 | + ```console |
| 59 | + FROM .internal.cases.cases-default | STATS count = COUNT(*) BY status | WHERE status == "in-progress" |
| 60 | + ``` |
| 61 | + |
| 62 | +* Find the total number of closed {{observability}} cases in the default space: |
| 63 | + |
| 64 | + ```console |
| 65 | + FROM .internal.cases.observability-default | STATS count = COUNT(*) BY status | WHERE status == "closed" |
| 66 | + ``` |
| 67 | + |
| 68 | +* Find Security cases that are open in the default space, and sort them by time, with the most recent at the top: |
| 69 | + |
| 70 | + ```console |
| 71 | + FROM .internal.cases.securitysolution-default | WHERE status == "open" | SORT created_at DESC |
| 72 | + ``` |
| 73 | + |
| 74 | +* Find the average time that it takes to close Security cases in the default space: |
| 75 | + |
| 76 | + ```console |
| 77 | + FROM .internal.cases.securitysolution-default | STATS average_time_to_close = AVG(time_to_resolve) |
| 78 | + ``` |
| 79 | + |
| 80 | +## Case analytics indices names and aliases [case-analytics-indices-names] |
| 81 | + |
| 82 | +{{es}} automatically creates the following case analytics indices and their aliases in spaces with case data. |
| 83 | + |
| 84 | +% ::::{note} |
| 85 | +% Go to [Case analytics indices schema](kibana://reference/case-analytics-indices-schema.md) for schema details. |
| 86 | +% :::: |
| 87 | + |
| 88 | +### General case data |
| 89 | + |
| 90 | +These indices store general data about cases. |
| 91 | + |
| 92 | +| Index | Alias | Created for | |
| 93 | +| ---------------------------- | ---------------------- |----------------------------------------- | |
| 94 | +| `.internal.cases.cases-<space-name>` | `.cases.cases-<space-name>` | Stack Management cases | |
| 95 | +| `.internal.cases.observability-<space-name>` | `.cases.observability-<space-name>` | {{observability}} cases | |
| 96 | +| `.internal.cases.securitysolution-<space-name>` | `.cases.securitysolution-<space-name>` | Security cases | |
| 97 | + |
| 98 | +### Case comments |
| 99 | + |
| 100 | +These indices store data related to comments. |
| 101 | + |
| 102 | +| Index | Alias | Created for | |
| 103 | +| ---------------------------- | ---------------------- |----------------------------------------- | |
| 104 | +| `.internal.cases-comments.cases-<space-name>` | `.cases-comments.cases-<space-name>` | Stack Management cases | |
| 105 | +| `.internal.cases-comments.observability-<space-name>` | `.cases-comments.observability-<space-name>` | {{observability}} cases | |
| 106 | +| `.internal.cases-comments.securitysolution-<space-name>` | `.cases-comments.securitysolution-<space-name>` | Security cases | |
| 107 | + |
| 108 | +### Case attachments |
| 109 | + |
| 110 | +These indices store data related to attachments. |
| 111 | + |
| 112 | +| Index | Alias | Created for | |
| 113 | +| ---------------------------- | ---------------------- |----------------------------------------- | |
| 114 | +| `.internal.cases-attachments.cases-<space-name>` | `.cases-attachments.cases-<space-name>` | Stack Management cases | |
| 115 | +| `.internal.cases-attachments.observability-<space-name>` | `.cases-attachments.observability-<space-name>` | {{observability}} cases | |
| 116 | +| `.internal.cases-attachments.securitysolution-<space-name>` | `.cases-attachments.securitysolution-<space-name>` | Security cases | |
| 117 | + |
| 118 | +### Case activity |
| 119 | + |
| 120 | +These indices store data related to activity. |
| 121 | + |
| 122 | +| Index | Alias | Created for | |
| 123 | +| ---------------------------- | ---------------------- |----------------------------------------- | |
| 124 | +| `.internal.cases-activity.cases-<space-name>` | `.cases-activity.cases-<space-name>` | Stack Management cases | |
| 125 | +| `.internal.cases-activity.observability-<space-name>` | `.cases-activity.observability-<space-name>` | {{observability}} cases | |
| 126 | +| `.internal.cases-activity.securitysolution-<space-name>` | `.cases-activity.securitysolution-<space-name>` | Security cases | |
0 commit comments