Skip to content
Merged
Show file tree
Hide file tree
Changes from 40 commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
9b4ee6b
Add first draft of Session View topic
benironside Apr 11, 2022
6835e35
Fix bugs
benironside Apr 11, 2022
b3f4130
Testing alternative section headers
benironside Apr 11, 2022
d2e7fc8
Troubleshoot modified headers, update image
benironside Apr 11, 2022
4e0e914
Minor fixes
benironside Apr 11, 2022
dfb7dc9
Adds information about what SV displays
benironside Apr 11, 2022
8d4ed37
Changes references to "agent" to "Endpoint Security"
benironside Apr 11, 2022
7ab47ef
Remove references to output
benironside Apr 11, 2022
3ff7fb8
Changes "details pane" to "details panel"
benironside Apr 11, 2022
8506a40
Addresses Mike's, Norrie's, and David's feedback
benironside Apr 12, 2022
a4ed832
Merge branch 'main' into issue-1781-big
benironside Apr 12, 2022
7cc8e5b
Update docs/detections/session-view.asciidoc
benironside Apr 14, 2022
9199a66
Update docs/detections/session-view.asciidoc
benironside Apr 14, 2022
87ec357
Update docs/detections/session-view.asciidoc
benironside Apr 14, 2022
221dcd4
Update docs/detections/session-view.asciidoc
benironside Apr 14, 2022
2961751
Update docs/detections/session-view.asciidoc
benironside Apr 14, 2022
c0cc23e
Update docs/detections/session-view.asciidoc
benironside Apr 14, 2022
499e238
Update docs/detections/session-view.asciidoc
benironside Apr 14, 2022
a19beda
Update docs/detections/session-view.asciidoc
benironside Apr 14, 2022
c901906
Update docs/detections/session-view.asciidoc
benironside Apr 14, 2022
3674149
Update docs/detections/session-view.asciidoc
benironside Apr 14, 2022
7cc399e
Update docs/detections/session-view.asciidoc
benironside Apr 14, 2022
bb201fa
Incorporate Joe's feedback
benironside Apr 14, 2022
5e3d060
Update docs/detections/session-view.asciidoc
benironside Apr 19, 2022
614553a
Update docs/detections/session-view.asciidoc
benironside Apr 19, 2022
3cecaaa
Update docs/detections/session-view.asciidoc
benironside Apr 19, 2022
b645bdf
Update docs/detections/session-view.asciidoc
benironside Apr 19, 2022
ff1f8d1
Update docs/detections/session-view.asciidoc
benironside Apr 19, 2022
ba1d8a1
Merge branch 'main' into issue-1781-big
benironside Apr 19, 2022
ffa62e4
Update docs/detections/session-view.asciidoc
benironside Apr 20, 2022
b1465f4
Update docs/detections/session-view.asciidoc
benironside Apr 20, 2022
20987bd
Update docs/detections/session-view.asciidoc
benironside Apr 20, 2022
345ada1
Update docs/detections/session-view.asciidoc
benironside Apr 20, 2022
883a9ab
Address feedback, update images to latest version of SV
benironside Apr 20, 2022
3f1a31b
Merge branch 'main' into issue-1781-big
benironside Apr 20, 2022
9c3552a
Merge branch 'issue-1781-big' of github.com:elastic/security-docs int…
benironside Apr 20, 2022
9e0d477
fixes build error
benironside Apr 20, 2022
f1e04e2
troubleshoots images
benironside Apr 21, 2022
f797532
Troubleshoots image resolution
benironside Apr 21, 2022
3108030
Fixes a stray period
benironside Apr 21, 2022
430a85e
Merge branch 'main' into issue-1781-big
benironside Apr 25, 2022
0d2fa14
update button and badge screenshots
benironside Apr 25, 2022
b70d9a7
Merge branch 'main' into issue-1781-big
benironside Apr 25, 2022
8d70ac9
Update docs/detections/session-view.asciidoc
benironside Apr 26, 2022
d2ae9e7
Incorporates Janeen's feedback
benironside Apr 26, 2022
9ea7669
Addresses bug where Authentications tab was present
benironside Apr 27, 2022
363793e
Merge branch 'main' into issue-1781-big
benironside Apr 27, 2022
5e02f0a
Merge branch 'main' into issue-1781-big
benironside Apr 28, 2022
File filter

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/detections/detections-index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ include::alerts-ui-manage.asciidoc[]

include::visual-event-analyzer.asciidoc[]

include::session-view.asciidoc[]

include::query-alert-indices.asciidoc[]

include::prebuilt-rules/tune-rule-signals.asciidoc[]
Expand Down
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.
85 changes: 85 additions & 0 deletions docs/detections/session-view.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
[[session-view]]
== Session View

beta::[]

Session View is an investigation tool that allows you to examine Linux process data organized
in a tree-like structure according to the Linux logical event model, with processes organized by parentage and time of execution.
It displays events in a highly readable format that is inspired by the terminal. This makes it a powerful tool for monitoring
and investigating session activity on your Linux infrastructure and understanding user and service behavior.

[float]
[[session-view-data]]
====== Session View displays:
* *Interactive and non-interactive processes:* Processes and services with or without a controlling tty.
* *User information:* The Linux user that executed each session or process, and any exec user changes.
* *Process and event telemetry:* Process information included in the Linux logical event model.
* *Nested sessions:* Sessions started by processes descended from the entry session.
* *Alerts:* Alerts in the context of the processes which caused them.

[float]
[[enable-session-view]]
=== Enable Session View data
Session View uses process data collected by the {endpoint-sec} integration,
but this data is not collected by default. To enable Session View data, go to *Manage* -> *Policies*
and edit one or more of your {endpoint-sec} integration policies. On the *Policy settings* tab,
scroll down to the Linux event collection section near the bottom of the page
and switch on the *Include session data* toggle. Only data collected by {endpoint-sec} with this setting
enabled can be viewed in Session View. For more information about the additional
fields collected by {endpoint-sec} when this setting is enabled, refer to https://github.com/elastic/ecs/blob/main/rfcs/text/0030-linux-event-model.md[here].

[float]
[[open-session-view]]
=== Open Session View
Session View is accessible from the **Hosts**, **Alerts**, and **Timelines** pages.
To open Session View, find an event or session you wish to view,
then click *Open Session View* under *Actions*. For example:

* On the Alerts page, go to *Detect* -> *Alerts*, then scroll down to view the Alerts table.
Events viewable in Session View have a rectangular **Open Session View** icon under **Actions**:
[role="screenshot"]
image::images/session-view-action-icon-detail.png[Detail of the Open Session View icon,width=75%]

* On the Hosts page, go to *Explore* -> *Hosts*, then select either the *Sessions* or the *Events* tab.
From either of these tabs, click the *Open Session View* icon for an event or session.
Labeled below are 1) the *Sessions* tab, and 2) the *Open Session View* icon:
[role="screenshot"]
image::images/session-view-hosts-page-sessions-tab-labeled.png[Detail of the Hosts page's Sessions tab]

[discrete]
[[session-view-ui]]
=== Session View UI
When you click *Open Session View*, the following display appears. Labeled features are described below:

[role="screenshot"]
image::images/session-view-terminal-labeled.png[Detail of Session view with labeled UI elements,width=150%]

1. The *Close Session* and *Full screen* buttons.
2. The search bar. Use it to find and highlight search terms within the current session.
The buttons on the right side of the search bar allow you to jump through search results.
3. The *display settings* button. Click to toggle Timestamps and Verbose mode.
With Verbose mode enabled, Session View shows all processes created in a session, including shell startup,
shell completion, and forks caused by built-in commands.
It defaults to *off* in order to highlight the data most likely to be user-generated and non-standard.
4. The *Detail panel* button. Click it to toggle the Detail panel, which appears below the button
and displays a wide range of additional information about the selected process’s ancestry and host,
and any associated alerts. To select a process in Session View, click on it.
5. The startup process. In this example it shows that the session was a bash session.
It also shows the Linux user "Ubuntu" started the session.
6. The *Child processes* button. Click to expand or collapse a process’s children.
You can also expand collapsed alerts and scripts where they appear.
Collapsed processes will automatically expand when their contents match a search.
7. The *Alerts* button. Click to show alerts caused by the parent process. Note the red line to the left
of the process that caused the alert.

Session View includes two additional icons not pictured above:

* The *Script* button allows you to expand or collapse executed scripts:

[role="screenshot"]
image::images/session-view-script-button.png[The Script button]

* The *Exec user change* badge highlights exec user changes, such as when a user escalates to root:

[role="screenshot"]
image::images/session-view-exec-user-change-badge.png[The Exec user change button]