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

Alerts can be shared via a shareable URL #3264

Merged
merged 15 commits into from
May 22, 2023
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
10 changes: 8 additions & 2 deletions docs/detections/alerts-view-details.asciidoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[[view-alert-details]]
== View detection alert details

To inspect a detection alert, click the *View details* button from the Alerts table. The alert details flyout appears with several options to view alert data.
To inspect a detection alert, click the *View details* button from the Alerts table. The alert details flyout appears with a way to share the alert and several options to view alert data.
nastasha-solomon marked this conversation as resolved.
Show resolved Hide resolved

[role="screenshot"]
image::images/view-alert-details.png[View details button, 200]
image::images/view-alert-details.png[View details button, 200]

The alert details flyout contains these informational tabs:

Expand All @@ -14,6 +14,12 @@ The alert details flyout contains these informational tabs:
* *JSON*: The alert data in JSON format.
* *Osquery Results*: Results from queries attached to rules display on the *Osquery Results* tab. <<add-osquery-response-action,Learn more.>>

To share an alert, click the **Share alert** link in the upper right corner of the flyout. This gives you a shareable URL that you can share with others or paste into a browser.

IMPORTANT: The **Share alert** link gives you a direct link to the alert's details flyout. Do _not_ use the general URL in the browser to share the alert. That URL will not work.
nastasha-solomon marked this conversation as resolved.
Show resolved Hide resolved

NOTE: If you've set the {kibana-ref}/settings.html#server-publicBaseUrl[`server.publicBaseUrl`] configuration setting in the `kibana.yml` file, you can also find the shareable URL in the `kibana.alert.url` field. You can find the field by going the *Table* tab and searching for `kibana.alert.url`.
nastasha-solomon marked this conversation as resolved.
Show resolved Hide resolved

[role="screenshot"]
image::images/alert-details-flyout.png[Alert details flyout, 90%]

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/alert-schema.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -156,5 +156,11 @@ Type: date
Type: date
|N/A | `kibana.alert.suppression.docs_count` | The number of suppressed alerts.

Type: long

|N/A | `kibana.alert.url` a| The shareable URL for the alert.

NOTE: This field only appears if you've set the {kibana-ref}/settings.html#server-publicBaseUrl[`server.publicBaseUrl`] configuration setting in the `kibana.yml` file.

Type: long
|==============================================