Skip to main content
Version: v1.6.0

Windows Event Log

This module allows the Security Engine to acquire logs from the Windows Event Log.

Configuration example

To monitor all events with the ID 4625, from the Security channel (ie, authentication failed):

source: wineventlog
log_level: info
event_channel: Security
event_ids:
- 4625
event_level: information
labels:
type: eventlog

You can also write a custom XPath query:

source: wineventlog
xpath_query: |
<QueryList><Query><Select Path=\"Security\">*[System[(EventID=42) and (Level=2)]]</Select></Query></QueryList>
labels:
type: eventlog

Parameters

event_channel

The name of the channel to read events from.

Must be set if xpath_query is not set.

event_level

The log level of the events to read.

Must be one of VERBOSE, INFORMATION, WARNING, ERROR or CRITICAL.

Only used if event_channel is specified.

event_ids

List of event IDs you want to match.

Only used if event_channel is specified.

xpath_query

A custom XPath query to read events.

Must be set if event_channel is not set.

You can refer to the Windows documentation for more informations: https://docs.microsoft.com/en-us/windows/win32/wes/consuming-events

pretty_name

Pretty name to use for the datasource in the metrics (cscli metrics).

This parameter is optional, but strongly recommanded, as by default the full xpath query will be displayed in the metrics, which can be hard to read.