Skip to content

Commit 3ca8c3b

Browse files
cosmo0920Pat
andauthored
in_winevtlog: Add descriptions about xml query for filtering events (fluent#1179)
* in_winevtlog: Add a description for Event_Query parameter Signed-off-by: Hiroshi Hatake <[email protected]> * in_winevtlog: Add query languages descriptions for event_query parameter Signed-off-by: Hiroshi Hatake <[email protected]> * Update pipeline/inputs/windows-event-log-winevtlog.md Co-authored-by: Pat <[email protected]> Signed-off-by: Hiroshi Hatake <[email protected]> * Update the sentence of supported types of queries. Co-authored-by: Pat <[email protected]> Signed-off-by: Hiroshi Hatake <[email protected]> * Clearify the sentence that describes Event_Query parameter. Co-authored-by: Pat <[email protected]> Signed-off-by: Hiroshi Hatake <[email protected]> --------- Signed-off-by: Hiroshi Hatake <[email protected]> Co-authored-by: Pat <[email protected]>
1 parent fbb006e commit 3ca8c3b

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

pipeline/inputs/windows-event-log-winevtlog.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ The plugin supports the following configuration parameters:
1616
| String\_Inserts | Whether to include StringInserts in output records. \(optional\) | True |
1717
| Render\_Event\_As\_XML | Whether to render system part of event as XML string or not. \(optional\) | False |
1818
| 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 |
19+
| Event\_Query | Specify XML query for filtering events. | `*` |
1920

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

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

4041
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.
4142

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

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

0 commit comments

Comments
 (0)