-
Notifications
You must be signed in to change notification settings - Fork 206
[DOCS] Linux deadlock troubleshooting & reference #2446
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 all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
18e7d59
First draft
joepeeples 4aed436
Fix typos
joepeeples e03a301
Add lead-in before steps
joepeeples c5548c3
Revise explanation about Agent, Filebeat, Endpoint
joepeeples 9a8b2dc
Add feedback from Janeen's review
joepeeples d032267
Merge branch 'main' into issue-2197-ts-linux-deadlock
joepeeples 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
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
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,80 @@ | ||
| [[linux-file-monitoring]] | ||
| = Configure Linux file system monitoring | ||
|
|
||
| By default, {endpoint-cloud-sec} monitors specific Linux file system types that Elastic has tested for compatibility. If your network includes nonstandard, proprietary, or otherwise unrecognized Linux file systems, you can configure the integration policy to extend monitoring and protections to those additional file systems. You can also have {endpoint-cloud-sec} ignore unrecognized file system types if they don't require monitoring or cause unexpected problems. | ||
|
|
||
| CAUTION: Ignoring file systems can create gaps in your security coverage. Use additional security layers for any file systems ignored by {endpoint-cloud-sec}. | ||
|
|
||
| To monitor or ignore additional file systems, configure the following advanced settings related to *fanotify*, a Linux feature that monitors file system events. Go to *Manage* -> *Policies*, click a policy's name, then scroll down and select *Show advanced settings*. | ||
|
|
||
| NOTE: Even when configured to monitor all file systems (`ignore_unknown_filesystems` is `false`), {endpoint-cloud-sec} will still ignore specific file systems that Elastic has internally identified as incompatible. The following settings apply to any _other_ file systems. | ||
|
|
||
| [[ignore-unknown-filesystems]] | ||
| `linux.advanced.fanotify.ignore_unknown_filesystems`:: Determines whether to ignore unrecognized file systems. Enter one of the following: | ||
| + | ||
| -- | ||
| * `true`: (Default) Monitor only Elastic-tested file systems, and ignore all others. You can still monitor or ignore specific file systems with `monitored_filesystems` and `ignored_filesystems`, respectively. | ||
|
|
||
| * `false`: Monitor all file systems. You can still ignore specific file systems with `ignored_filesystems`. | ||
| -- | ||
| + | ||
| NOTE: If you've upgraded from 8.3 or earlier, this value will be `false` for backwards compatibility. If you don't need to monitor additional file systems, it's recommended to change `ignore_unknown_filesystems` to `true` after upgrading. | ||
|
|
||
| [[monitored-filesystems]] | ||
| `linux.advanced.fanotify.monitored_filesystems`:: Specifies additional file systems to monitor. Enter a comma-separated list of <<find-file-system-names,file system names>> as they appear in `/proc/filesystems` (for example: `jfs,ufs,ramfs`). | ||
| + | ||
| NOTE: It's recommended to avoid monitoring network-backed file systems. | ||
| + | ||
| This setting isn't recognized if `ignore_unknown_filesystems` is `false`, since that would mean you're already monitoring _all_ file systems. | ||
| + | ||
| Entries in this setting are overridden by entries in `ignored_filesystems`. | ||
|
|
||
| [[ignored-filesystems]] | ||
| `linux.advanced.fanotify.ignored_filesystems`:: Specifies additional file systems to ignore. Enter a comma-separated list of <<find-file-system-names,file system names>> as they appear in `/proc/filesystems` (for example: `ext4,tmpfs`). | ||
| + | ||
| Entries in this setting override entries in `monitored_filesystems`. | ||
|
|
||
| [[find-file-system-names]] | ||
| == Find file system names | ||
|
|
||
| This section provides a few ways to determine the file system names needed for `linux.advanced.fanotify.monitored_filesystems` and `linux.advanced.fanotify.ignored_filesystems`. | ||
|
|
||
| In a typical setup, when you install {agent}, {filebeat} is installed alongside {elastic-endpoint} and will automatically ship {elastic-endpoint} logs to {es}. {elastic-endpoint} will generate a log message about the file that was scanned when an event occurs. | ||
|
|
||
| To find the system file name: | ||
|
|
||
| . From the Hosts page (*Explore* -> *Hosts*), search for `message: "Current sync path"` to reveal the file path. | ||
|
|
||
| . If you have access to the endpoint, run `findmnt -o FSTYPE -T <file path>` to return the file system. For example: | ||
| + | ||
| [source,shell] | ||
| ---- | ||
| > findmnt -o FSTYPE -T /etc/passwd | ||
| FSTYPE | ||
| ext4 | ||
| ---- | ||
| + | ||
| This returns the file system name as `ext4`. | ||
|
|
||
| Alternatively, you can also find the file system name by correlating data from two other log messages: | ||
|
|
||
| . Search the logs for `message: "Current fdinfo"` to reveal the `mnt_id` value of the file path. In this example, the `mnt_id` value is `29`: | ||
| + | ||
| [source,shell] | ||
| ---- | ||
| pos: 12288 | ||
| flags: 02500002 | ||
| mnt_id: 29 | ||
| ino: 2367737 | ||
| ---- | ||
|
|
||
| . Search the logs for `message: "Current mountinfo"` to reveal the file system that corresponds to the `mnt_id` value you found in the previous step: | ||
| + | ||
| [source,shell] | ||
| ---- | ||
| <snip> | ||
| 29 1 8:2 / / rw,relatime shared:1 - ext4 /dev/sda2 rw,errors=remount-ro | ||
| <snip> | ||
| ---- | ||
| + | ||
| The first number, `29`, is the `mnt_id`, and the first field after the hyphen (`-`) is the file system name, `ext4`. | ||
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
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.