-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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
Add documentation for Winlogbeat modules #12361
Conversation
Pinging @elastic/secops |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Two small suggestions that you can pick up or not.
winlogbeat/docs/modules.asciidoc
Outdated
Winlogbeat before the events are delivered to the output. | ||
|
||
The general goal of each module is to transform events by renaming fields to | ||
comply with the Elastic Common Schema (ECS). The modules may also apply |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe link to ECS docs (if somebody doesn't know what it is)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added.
|
||
The default configuration file includes configuration for Sysmon. If you do not | ||
have Sysmon installed Winlogbeat will log a warning that you can ignore stating | ||
that it could not read from the `Microsoft-Windows-Sysmon/Operational` channel. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I stumbled over this long sentence. Maybe split it / merge it with the next, e.g.: If you do not have Sysmon installed Winlogbeat will log a warning that it could not read from the
Microsoft-Windows-Sysmon/Operational channel. You can ignore this, it will continue to read from the other configured channels.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To simplify the long sentence I removed the comment about ignoring the warning. I think that's implicit.
Add documentation for the security and sysmon modules that explains what the modules accomplish and how to configure them. Relates elastic#11651
- Add ECS link - Simplify sentence in sysmon docs
83d391f
to
986ccaa
Compare
Add documentation for the security and sysmon modules that explains what the modules accomplish and how to configure them. Relates elastic#11651 (cherry picked from commit 0ff05eb)
Add documentation for the security and sysmon modules that explains what the modules accomplish and how to configure them. Relates elastic#11651
Add documentation for the security and sysmon modules that explains what the modules accomplish and how to configure them. Relates elastic#11651 (cherry picked from commit 3cf45cb)
Add documentation for the security and sysmon modules that explains
what the modules accomplish and how to configure them.
Relates #11651