- Notifications
You must be signed in to change notification settings - Fork 206
[DOCS] [AWP] [8.2] Session View topic #1824
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
Merged
Merged
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 6835e35 Fix bugs
benironside b3f4130 Testing alternative section headers
benironside d2e7fc8 Troubleshoot modified headers, update image
benironside 4e0e914 Minor fixes
benironside dfb7dc9 Adds information about what SV displays
benironside 8d4ed37 Changes references to "agent" to "Endpoint Security"
benironside 7ab47ef Remove references to output
benironside 3ff7fb8 Changes "details pane" to "details panel"
benironside 8506a40 Addresses Mike's, Norrie's, and David's feedback
benironside a4ed832 Merge branch 'main' into issue-1781-big
benironside 7cc8e5b Update docs/detections/session-view.asciidoc
benironside 9199a66 Update docs/detections/session-view.asciidoc
benironside 87ec357 Update docs/detections/session-view.asciidoc
benironside 221dcd4 Update docs/detections/session-view.asciidoc
benironside 2961751 Update docs/detections/session-view.asciidoc
benironside c0cc23e Update docs/detections/session-view.asciidoc
benironside 499e238 Update docs/detections/session-view.asciidoc
benironside a19beda Update docs/detections/session-view.asciidoc
benironside c901906 Update docs/detections/session-view.asciidoc
benironside 3674149 Update docs/detections/session-view.asciidoc
benironside 7cc399e Update docs/detections/session-view.asciidoc
benironside bb201fa Incorporate Joe's feedback
benironside 5e3d060 Update docs/detections/session-view.asciidoc
benironside 614553a Update docs/detections/session-view.asciidoc
benironside 3cecaaa Update docs/detections/session-view.asciidoc
benironside b645bdf Update docs/detections/session-view.asciidoc
benironside ff1f8d1 Update docs/detections/session-view.asciidoc
benironside ba1d8a1 Merge branch 'main' into issue-1781-big
benironside ffa62e4 Update docs/detections/session-view.asciidoc
benironside b1465f4 Update docs/detections/session-view.asciidoc
benironside 20987bd Update docs/detections/session-view.asciidoc
benironside 345ada1 Update docs/detections/session-view.asciidoc
benironside 883a9ab Address feedback, update images to latest version of SV
benironside 3f1a31b Merge branch 'main' into issue-1781-big
benironside 9c3552a Merge branch 'issue-1781-big' of github.com:elastic/security-docs int…
benironside 9e0d477 fixes build error
benironside f1e04e2 troubleshoots images
benironside f797532 Troubleshoots image resolution
benironside 3108030 Fixes a stray period
benironside 430a85e Merge branch 'main' into issue-1781-big
benironside 0d2fa14 update button and badge screenshots
benironside b70d9a7 Merge branch 'main' into issue-1781-big
benironside 8d70ac9 Update docs/detections/session-view.asciidoc
benironside d2ae9e7 Incorporates Janeen's feedback
benironside 9ea7669 Addresses bug where Authentications tab was present
benironside 363793e Merge branch 'main' into issue-1781-big
benironside 5e02f0a Merge branch 'main' into issue-1781-big
benironside 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
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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.
Binary file added BIN +85.2 KB docs/detections/images/session-view-hosts-page-sessions-tab-labeled.png
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
| 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. | ||
benironside marked this conversation as resolved. Show resolved Hide resolved | ||
| * *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 | ||
benironside marked this conversation as resolved. Outdated Show resolved Hide resolved | ||
| 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]. | ||
benironside marked this conversation as resolved. Outdated Show resolved Hide resolved | ||
| | ||
| [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: | ||
benironside marked this conversation as resolved. Outdated Show resolved Hide resolved | ||
| | ||
| * 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%] | ||
benironside marked this conversation as resolved. Outdated Show resolved Hide resolved | ||
| | ||
| * On the Hosts page, go to *Explore* -> *Hosts*, then select either the *Sessions* or the *Events* tab. | ||
benironside marked this conversation as resolved. Outdated Show resolved Hide resolved | ||
| 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: | ||
benironside marked this conversation as resolved. Outdated Show resolved Hide resolved | ||
| | ||
| [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. | ||
benironside marked this conversation as resolved. Outdated Show resolved Hide resolved | ||
| 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. | ||
benironside marked this conversation as resolved. Outdated Show resolved Hide resolved | ||
| 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] | ||
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.