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.

Sign up for GitHub

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

in_winevtlog: Add descriptions about xml query for filtering events #1179

Merged
merged 5 commits into from
Jan 18, 2024
Merged

in_winevtlog: Add descriptions about xml query for filtering events #1179

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7a186da
in_winevtlog: Add a description for Event_Query parameter
cosmo0920 Aug 22, 2023
d47cc9f
in_winevtlog: Add query languages descriptions for event_query parameter
cosmo0920 Aug 22, 2023
992e7a7
Update pipeline/inputs/windows-event-log-winevtlog.md
cosmo0920 Aug 22, 2023
be55d25
Update the sentence of supported types of queries.
cosmo0920 Aug 22, 2023
1ca47de
Clearify the sentence that describes Event_Query parameter.
cosmo0920 Aug 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions pipeline/inputs/windows-event-log-winevtlog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ The plugin supports the following configuration parameters:
| String\_Inserts | Whether to include StringInserts in output records. \(optional\) | True |
| Render\_Event\_As\_XML | Whether to render system part of event as XML string or not. \(optional\) | False |
| Use\_ANSI | Use ANSI encoding on eventlog messages. If you have issues receiving blank strings with old Windows versions (Server 2012 R2), setting this to True may solve the problem. \(optional\) | False |
| Event\_Query | Specify XML query for filtering events. | `*` |

Note that if you do not set _db_, the plugin will tail channels on each startup.

Expand All @@ -39,6 +40,12 @@ Here is a minimum configuration example.

Note that some Windows Event Log channels \(like `Security`\) requires an admin privilege for reading. In this case, you need to run fluent-bit as an administrator.

#### Query Languages for Event_Query Parameter

The `Event_Query` parameter can be used to specify the XML query for filtering Windows EventLog during collection.
The supported query types are [XPath](https://developer.mozilla.org/en-US/docs/Web/XPath) and XML Query.
For further details, please refer to [the MSDN doc](https://learn.microsoft.com/en-us/windows/win32/wes/consuming-events).

### Command Line

If you want to do a quick test, you can run this plugin from the command line.
Expand Down