This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Avoid YAML formatting problems PowerShell Module »
Elastic Docs ›Winlogbeat Reference [master]

Modules

edit

Modules

edit

Winlogbeat modules have changed in 8.0.0 to use Elasticsearch Ingest Node for processing. If you are upgrading from 7.x please review the documentation and see the default configuration file.

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.

The provided modules only support events in English. For more information about how to configure the language in winlogbeat, refer to Winlogbeat.

Setup of Ingest Node pipelines

edit

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

  1. On connection to Elasticsearch
  2. setup command
  3. Manually install pipelines

Usage with Forwarded Events

edit

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

Modules

edit
« Avoid YAML formatting problems PowerShell Module »