Skip to content
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

Add Observability case templates #4049

Merged
merged 3 commits into from
Jul 10, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/en/observability/create-cases.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ add assignees and tags to your cases, set their severity and status, and add ale
comments, and visualizations. You can also send cases to third party systems by
<<cases-external-connectors,configuring external connectors>>.

You can also optionally add custom fields and case templates. preview:[]

[role="screenshot"]
image::images/cases.png[Cases page]
// NOTE: This is an autogenerated screenshot. Do not edit it directly.
Expand Down
Binary file modified docs/en/observability/images/cases-custom-field-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 16 additions & 3 deletions docs/en/observability/manage-cases.asciidoc
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
[[manage-cases]]
= Open and manage new cases

To perform these tasks, you must have <<grant-cases-access,full access>> to the {observability} case feature in {kib}.

[discrete]
[[new-case-observability]]
== Open a new case

Open a new case to keep track of issues and share the details with colleagues.

. Go to *Cases* -> *Create new case*.
. preview:[] If you defined <<observability-case-templates,templates>>, optionally select one to use its default field values.
. Give the case a name, severity, and description.
+
TIP: In the `Description` area, you can use
https://www.markdownguide.org/cheat-sheet[Markdown] syntax to create formatted text.

. Optionally, add a category, assignees, and tags.
You can add users only if they meet the necessary <<grant-cases-access,prerequisites>>.

. preview:[] If you defined <<case-custom-fields,custom fields>>, they appear in the *Additional fields* section.
. Under External incident management system, select a <<cases-external-connectors,connector>>. If
you've previously added one, that connector displays as the default selection. Otherwise, the
default setting is `No connector selected`.
Expand All @@ -35,8 +38,6 @@ You can add optional and required fields for customized case collaboration.
[role="screenshot"]
image::images/cases-custom-field-settings.png[View custom fields in case settings]
// NOTE: This is an autogenerated screenshot. Do not edit it directly.

NOTE: To view and change case settings, you must have the appropriate {kib} feature privileges. Refer to <<grant-cases-access>>.
--

. In the *Custom fields* section, click *Add field*.
Expand Down Expand Up @@ -142,3 +143,15 @@ To view a case, click on its name. You can then:
* Refresh the case to retrieve the latest updates.
* Close the case.
* Reopen a closed case.

[discrete]
[[observability-case-templates]]
== Case templates

preview::[]

You can make the case creation process faster and more consistent by adding templates in *Cases > Settings*.
lcawl marked this conversation as resolved.
Show resolved Hide resolved
A template defines values for one or all of the case fields (such as severity, tags, description, and title) as well as any <<case-custom-fields,custom fields>>.
When users create cases, they can optionally select a template and use its field values.

NOTE: If you update or delete templates, existing cases are unaffected.
Loading