- Winlogbeat Reference: other versions:
- Winlogbeat Overview
- Quick start: installation and configuration
- Set up and run
- Upgrade
- Configure
- Winlogbeat
- General settings
- Project paths
- Output
- Kerberos
- SSL
- Index lifecycle management (ILM)
- Elasticsearch index template
- Kibana endpoint
- Kibana dashboards
- Processors
- Define processors
- add_cloud_metadata
- add_cloudfoundry_metadata
- add_docker_metadata
- add_fields
- add_host_metadata
- add_id
- add_kubernetes_metadata
- add_labels
- add_locale
- add_network_direction
- add_nomad_metadata
- add_observer_metadata
- add_process_metadata
- add_tags
- append
- community_id
- convert
- copy_fields
- decode_base64_field
- decode_duration
- decode_json_fields
- decode_xml
- decode_xml_wineventlog
- decompress_gzip_field
- detect_mime_type
- dissect
- dns
- drop_event
- drop_fields
- extract_array
- fingerprint
- include_fields
- move_fields
- rate_limit
- registered_domain
- rename
- replace
- script
- syslog
- timestamp
- translate_ldap_attribute
- translate_sid
- truncate_fields
- urldecode
- Internal queue
- Logging
- HTTP endpoint
- Instrumentation
- winlogbeat.reference.yml
- How to guides
- Modules
- Exported fields
- Monitor
- Secure
- Troubleshoot
- Get Help
- Debug
- Understand logged metrics
- Common problems
- Dashboard in Kibana is breaking up data fields incorrectly
- Bogus computer_name fields are reported in some events
- Error loading config file
- Found unexpected or unknown characters
- Logstash connection doesn’t work
- Publishing to Logstash fails with "connection reset by peer" message
- @metadata is missing in Logstash
- Not sure whether to use Logstash or Beats
- SSL client fails to connect to Logstash
- Monitoring UI shows fewer Beats than expected
- Dashboard could not locate the index-pattern
- High RSS memory usage due to MADV settings
- Not sure how to read from .evtx files
- Contribute to Beats
Modules
editModules
editWinlogbeat 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
editWinlogbeat’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
Usage with Forwarded Events
editNo 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
editElasticON events are back!
Learn about the Elastic Search AI Platform from the experts at our live events.
Register now