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

[8.15 & Serverless] Update the Security Timeline Documentation in accordance with new Unified Timeline changes #5505

Merged
merged 33 commits into from
Jul 23, 2024
Merged
Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
187460c
First draft
nastasha-solomon Jul 3, 2024
782e35c
Merge branch 'main' into issue-5341-unified-timeline-integration
nastasha-solomon Jul 3, 2024
b0b2ae4
Fix broken image ref
nastasha-solomon Jul 3, 2024
e1cecf0
Runtime fields
nastasha-solomon Jul 4, 2024
90d5e2d
Updated timeline schema
nastasha-solomon Jul 4, 2024
37b24c9
fixed file ext
nastasha-solomon Jul 4, 2024
1553b4d
Updates Serverless Timeline docs
nastasha-solomon Jul 4, 2024
9f7884e
Second batch of Serverless updates
nastasha-solomon Jul 4, 2024
5f3dde5
Fixed typos
nastasha-solomon Jul 4, 2024
75bb945
Fixed syntax and image ref
nastasha-solomon Jul 4, 2024
0766c5f
Made images larger
nastasha-solomon Jul 4, 2024
7c9d2e1
Merge branch 'main' into issue-5341-unified-timeline-integration
nastasha-solomon Jul 4, 2024
6ae3d47
One more update to size
nastasha-solomon Jul 4, 2024
ba6f968
Merge branch 'issue-5341-unified-timeline-integration' of github.com:…
nastasha-solomon Jul 4, 2024
18f3685
Update docs/serverless/investigate/timelines-ui.mdx
nastasha-solomon Jul 5, 2024
cc234bb
Update docs/events/timeline-ui-overview.asciidoc
nastasha-solomon Jul 5, 2024
78ea976
Fixed serverless section
nastasha-solomon Jul 5, 2024
8b90168
Minor edits
nastasha-solomon Jul 5, 2024
af7d328
Merge branch 'main' into issue-5341-unified-timeline-integration
nastasha-solomon Jul 5, 2024
dc63100
Merge branch 'main' into issue-5341-unified-timeline-integration
nastasha-solomon Jul 16, 2024
496b82b
Merge branch 'main' into issue-5341-unified-timeline-integration
nastasha-solomon Jul 18, 2024
8bb9978
More input from dev review
nastasha-solomon Jul 18, 2024
9047076
Updating list in serverless docs
nastasha-solomon Jul 18, 2024
4b02bac
Merge branch 'main' into issue-5341-unified-timeline-integration
nastasha-solomon Jul 19, 2024
d282278
Updating images for corr tab and temps
nastasha-solomon Jul 19, 2024
6508952
Update docs/events/timeline-ui-overview.asciidoc
nastasha-solomon Jul 22, 2024
9bac051
Update docs/events/timeline-ui-overview.asciidoc
nastasha-solomon Jul 22, 2024
594b681
Update docs/events/timeline-ui-overview.asciidoc
nastasha-solomon Jul 22, 2024
76cf915
Merge branch 'main' into issue-5341-unified-timeline-integration
nastasha-solomon Jul 22, 2024
e20b7f1
Nat's edits
nastasha-solomon Jul 22, 2024
7d524a7
Renamed image for timeline template
nastasha-solomon Jul 22, 2024
bd9d390
Corrected file name one more time
nastasha-solomon Jul 22, 2024
ad2d793
Merge branch 'main' into issue-5341-unified-timeline-integration
nastasha-solomon Jul 23, 2024
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
Binary file modified docs/detections/images/ig-timeline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/events/images/add-field-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/events/images/correlation-tab-eql-query.png
nastasha-solomon marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/events/images/create-a-timeline-filter.png
nastasha-solomon marked this conversation as resolved.
Show resolved Hide resolved
nastasha-solomon marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/events/images/customize-event-renderers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/events/images/remove-field-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/events/images/timeline-sidebar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/events/images/timeline-ui-filter-options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/events/images/timeline-ui-renderer.png
nastasha-solomon marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/events/images/timeline-ui-updated.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: 15 additions & 4 deletions docs/events/timeline-ui-overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,7 @@ To further inspect an event or detection alert, click the *View details* button.
== Configure Timeline event context and display

Many types of events automatically appear in preconfigured views that provide relevant
contextual information, called *Event Renderers*. You can display and turn them on or off
with the Settings menu in the upper left corner of the results pane:
contextual information, called *Event renderers*. All event renders are turned off by default. To turn them on, use the **Event renderers** toggle at the top of the results pane. To only turn on specific event renders, click the gear (image:images/customize-event-renderers.png[The customize event renderer button,20,20]) button next to the toggle, and select the ones you want enabled. Close the **Customize event renderers** pane when you're done. Your changes are automatically applied to Timeline.
nastasha-solomon marked this conversation as resolved.
Show resolved Hide resolved

[role="screenshot"]
image::images/timeline-ui-renderer.png[example timeline with the event renderer highlighted]
Expand All @@ -67,13 +66,25 @@ interests you, you can drag it up to the drop zone below the query bar for furth

You can also modify a Timeline's display in other ways:

* Add, remove, reorder, or resize columns
* Create <<runtime-fields,runtime fields>> and display them in the Timeline
* <<add-remove-timeline-fields,Add and remove fields>> from Timeline
* Create <<runtime-fields,runtime fields>> and display them in Timeline
* Reorder and resize columns
* View the Timeline in full screen mode
* Add or delete notes on individual events
* Add or delete investigation notes on the entire Timeline
* Pin interesting events to the Timeline

[discrete]
[[add-remove-timeline-fields]]
== Add and remove fields from Timeline

The Timeline table shows fields that are available for alerts and events in the selected data view. You can modify the table to display fields that interest you. Use the sidebar to search for specific fields or scroll through it to find fields of interest. Fields that you select display as columns in the table.

To add a field from the sidebar, hover over it, and click the **Add field as a column** button (image:images/add-field-button.png[The button that lets you to add a field as a column,20,20]), or drag and drop the field into the table. To remove a field, hover over it, and click the **Remove field as a column** button (image:images/remove-field-button.png[The button that lets you to remove a field as a column,20,20]).

[role="screenshot"]
image::images/timeline-sidebar.png[Shows the sidebar that allows you to configure the columns that display in Timeline]

[discrete]
[[narrow-expand]]
== Use the Timeline query builder
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/reference/images/timeline-object-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 6 additions & 5 deletions docs/reference/runtime-fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,17 @@ To create a runtime field:

. Go to a page that lists alerts or events (for example, *Alerts* or *Timelines* -> *_Name of Timeline_*).

. Click the *Fields* toolbar button in the table's upper-left. The *Fields* browser opens.
. Do one of the following:
** In the Alerts table, click the *Fields* toolbar button in the table's upper-left. From the *Fields* browser, click *Create field*. The *Create field* flyout opens.
+
[role="screenshot"]
image::images/fields-browser.png[Fields browser]

. Click *Create field*. The *Create field* flyout opens.
+
** In Timeline, go to the bottom of the sidebar, then click *Add a field*. The *Create field* flyout opens.
+
[role="screenshot"]
image::images/create-field-flyout.png[Create field flyout]

image::images/create-runtime-fields-timeline.png[Create runtime fields button in Timeline]
+
. Enter a *Name* for the new field.

. Select a *Type* for the field's data type.
Expand Down
10 changes: 6 additions & 4 deletions docs/serverless/explore/runtime-fields.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,19 @@ You can create a runtime field and add it to your detection alerts or events fro
Runtime fields can impact performance because they're evaluated each time a query runs. Refer to [Runtime fields](((ref))/runtime.html) for more information.
</DocCallOut>

To create a runtime field:
To create a runtime field:

1. Go to a page that lists alerts or events (for example, **Alerts** or **Timelines** → **_Name of Timeline_**).

1. Click the **Fields** toolbar button in the table's upper-left. The **Fields** browser opens.
1. Do one of the following:

* In the Alerts table, click the **Fields** toolbar button in the table's upper-left. From the **Fields** browser, click **Create field**. The **Create field** flyout opens.

![Fields browser](../images/runtime-fields/-reference-fields-browser.png)

1. Click **Create field**. The **Create field** flyout opens.
* In Timeline, go to the bottom of the sidebar, then click **Add a field**. The **Create field** flyout opens.

![Create field flyout](../images/runtime-fields/-reference-create-field-flyout.png)
![Create runtime fields button in Timeline](../images/runtime-fields/-reference-create-runtime-fields-timeline.png)

1. Enter a **Name** for the new field.

Expand Down
nastasha-solomon marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 14 additions & 4 deletions docs/serverless/investigate/timelines-ui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,7 @@ To further inspect an event or detection alert, click the **View details** butto
## Configure Timeline event context and display

Many types of events automatically appear in preconfigured views that provide relevant
contextual information, called **Event Renderers**. You can display and turn them on or off
with the Settings menu in the upper left corner of the results pane:
contextual information, called **Event Renderers**. All event renders are turned off by default. To turn them on, use the **Event renderers** toggle at the top of the results pane. To only turn on specific event renders, click the gear (<DocIcon type="gear" title="The customize event renderer button" />) button next to the toggle, and select the ones you want enabled. Close the **Customize event renderers** pane when you're done. Your changes are automatically applied to Timeline.

![example timeline with the event renderer highlighted](../images/timelines-ui/-events-timeline-ui-renderer.png)

Expand All @@ -73,13 +72,24 @@ interests you, you can drag it up to the drop zone below the query bar for furth

You can also modify a Timeline's display in other ways:

* Add, remove, reorder, or resize columns
* <DocLink slug="/serverless/security/timelines-ui" section="add-remove-timeline-fields">Add and remove fields</DocLink> from Timeline
* Create <DocLink slug="/serverless/security/runtime-fields">runtime fields</DocLink> and display them in the Timeline
* Reorder and resize columns
* View the Timeline in full screen mode
* Add or delete notes on individual events
* Add or delete investigation notes on the entire Timeline
* Pin interesting events to the Timeline

<div id="add-remove-timeline-fields"></div>

## Add and remove fields from Timeline

The Timeline table shows fields that are available for alerts and events in the selected data view. You can modify the table to display fields that interest you. Use the sidebar to search for specific fields or scroll through it to find fields of interest. Fields that you select display as columns in the table.

To add a field from the sidebar, hover over it, and click the **Add field as a column** button (<DocIcon type="plusInCircle" title="The button that lets you to add a field as a column" />), or drag and drop the field into the table. To remove a field, hover over it, and click the **Remove field as a column** button (<DocIcon type="cross" title="The button that lets you to remove a field as a column" />).

<DocImage size="xl" url="../images/timelines-ui/-events-timeline-sidebar.png" alt="Shows the sidebar that allows you to configure the columns that display in Timeline" />

<div id="narrow-expand"></div>

## Use the Timeline query builder
Expand All @@ -96,7 +106,7 @@ Collapse the query builder and provide more space for Timeline results by clicki

Click a filter to access additional operations such as **Add filter**, **Clear all**, **Load saved query**, and more:

<DocImage size="m" url="../images/timelines-ui/-events-timeline-ui-filter-options.png" alt="" />
<DocImage size="l" url="../images/timelines-ui/-events-timeline-ui-filter-options.png" alt="" />

Here are examples of various types of filters:

Expand Down
Loading