Modules

This section contains detailed information about the available Windows event log processing modules contained in Winlogbeat. More details about each module can be found in the module’s documentation.

Winlogbeat modules are implemented using Elasticsearch Ingest Node pipelines. The events receive their transformations within Elasticsearch. All events are sent through Winlogbeat’s "routing" pipeline that routes events to specific module pipelines based on their winlog.channel value.

Winlogbeat’s default config file contains the option to send all events to the routing pipeline. If you remove this option then the module processing will not be applied.

output.elasticsearch.pipeline: winlogbeat-%{[agent.version]}-routing

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 additional categorization, tagging, and parsing as necessary.

Winlogbeat’s Ingest Node pipelines must be installed to Elasticsearch if you want to apply the module processing to events. The simplest way to get started is to use the Elasticsearch output and Winlogbeat will automatically install the pipelines when it first connects to Elasticsearch.

Installation Methods

No special configuration options are required when working with the ForwardedEvents channel. The events in this log retain the channel name of their origin (e.g. winlog.channel: Security). And because the routing pipeline processes events based on the channel name no special config is necessary.

winlogbeat.event_logs:
- name: ForwardedEvents
  tags: [forwarded]
  language: 0x0409 # en-US

output.elasticsearch.pipeline: winlogbeat-%{[agent.version]}-routing