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

Add documentation for Winlogbeat modules #12361

Merged
merged 3 commits into from
Jun 3, 2019

Conversation

andrewkroh
Copy link
Member

Add documentation for the security and sysmon modules that explains
what the modules accomplish and how to configure them.

Relates #11651

@andrewkroh andrewkroh added docs review Winlogbeat needs_backport PR is waiting to be backported to other branches. labels May 29, 2019
@andrewkroh andrewkroh requested a review from a team as a code owner May 29, 2019 23:41
@elasticmachine
Copy link
Collaborator

Pinging @elastic/secops

Copy link
Contributor

@cwurm cwurm left a 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 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
Copy link
Contributor

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)?

Copy link
Member Author

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.
Copy link
Contributor

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.

Copy link
Member Author

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
@andrewkroh andrewkroh force-pushed the feature/wlb/module-docs branch from 83d391f to 986ccaa Compare June 3, 2019 21:28
@andrewkroh andrewkroh merged commit 0ff05eb into elastic:master Jun 3, 2019
andrewkroh added a commit to andrewkroh/beats that referenced this pull request Jun 3, 2019
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)
@andrewkroh andrewkroh added v7.2.0 and removed needs_backport PR is waiting to be backported to other branches. labels Jun 3, 2019
andrewkroh added a commit that referenced this pull request Jun 4, 2019
Add documentation for the security and sysmon modules that explains
what the modules accomplish and how to configure them.

Relates #11651

(cherry picked from commit 0ff05eb)
andrewvc pushed a commit to andrewvc/beats that referenced this pull request Jun 12, 2019
Add documentation for the security and sysmon modules that explains
what the modules accomplish and how to configure them.

Relates elastic#11651
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants