Skip to content

Commit

Permalink
[DOCS] Assign users to Observability cases (#2267) (#2268)
Browse files Browse the repository at this point in the history
(cherry picked from commit 2e5fa93)

Co-authored-by: Lisa Cawley <[email protected]>
  • Loading branch information
mergify[bot] and lcawl authored Oct 13, 2022
1 parent 0c3534f commit 1c8aaad
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 9 deletions.
8 changes: 5 additions & 3 deletions docs/en/observability/create-cases.asciidoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
[[create-cases]]
= Cases

Cases are used to open and track observability issues directly in the Elastic {observability} app.
All cases list the original reporter and all the users who contribute to a case (participants).
You can also send cases to third party systems by <<cases-external-connectors,configuring external connectors>>.
Cases are used to open and track observability issues directly in the Elastic
{observability} app. You can add assignees and tags to your cases, set their
severity and status, and add alerts, comments, and visualizations. You can also
send cases to third party systems by
<<cases-external-connectors,configuring external connectors>>.

[role="screenshot"]
image::images/cases.png[Cases page]
Expand Down
6 changes: 6 additions & 0 deletions docs/en/observability/grant-cases-access.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ a|

NOTE: Roles without `All` *{connectors-feature}* feature privileges cannot create, add, delete, or modify case connectors.

| Give assignee access to cases
a| `All` for the *Cases* feature under *{observability}*.

NOTE: Before a user can be assigned to a case, they must log into {kib} at
least once, which creates a user profile.

| Give view-only access for cases | `Read` for the *Cases* feature under *{observability}*.

| Give access to view and delete cases | `Read` for the *Cases* feature under *{observability}* with the deletion sub-feature enabled.
Expand Down
Binary file modified docs/en/observability/images/cases.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 12 additions & 6 deletions docs/en/observability/manage-cases.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,35 @@
Open a new case to keep track of issues and share the details with colleagues.

. Go to *Cases* -> *Create new case*.
. Give the case a name, add any identifying tags, and enter a description.
. 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 assignees and tags. You can add users only if they meet the
necessary <<grant-cases-access,prerequisites>>.

. Under External incident management system, select a <<cases-external-connectors,connector>>. If
youve previously added one, that connector displays as the default selection. Otherwise, the
you've previously added one, that connector displays as the default selection. Otherwise, the
default setting is `No connector selected`.
. After youve completed all of the required fields, click *Create case*.
. After you've completed all of the required fields, click *Create case*.

[discrete]
[[manage-case-observability]]
== Manage existing cases

You can search existing cases and filter them by tags, reporter, and status: *open*, *in-progress*, or *closed*.
You can search existing cases and filter them by assignee, severity, status, and tags.

To view a case, click on its name. You can then:

* Add a new comment.
* Edit existing comments and the description.
* Add or remove assignees.
* Add a <<cases-external-connectors,connector>> (if you did not select one while creating the case).
* Send updates to external systems (if external connections are configured).
* Edit tags.
* Change the status.
* Change the severity.
* Refresh the case to retrieve the latest updates.
* Close the case.
* Reopen a closed case.
* Edit tags.
* Refresh the case to retrieve the latest updates.

0 comments on commit 1c8aaad

Please sign in to comment.