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 a description for Read_Limit_Per_Cycle #1350

Merged
merged 3 commits into from
Apr 17, 2024
Merged

in_winevtlog: Add a description for Read_Limit_Per_Cycle #1350

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b0a3a8
in_winevtlog: Add a description for threshold_size
cosmo0920 Apr 5, 2024
822a057
in_winevtlog: Follow the change of parameter name
cosmo0920 Apr 9, 2024
c9104b2
Simplify the description and add the devault value for read_limit_per…
cosmo0920 Apr 10, 2024
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
5 changes: 5 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 @@ -17,6 +17,7 @@ The plugin supports the following configuration parameters:
| 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. | `*` |
| Read\_Limit\_Per\_Cycle | Specify read limit per cycle. | 512KiB |

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

Expand All @@ -40,6 +41,10 @@ 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.

The default value of Read\_Limit\_Per\_Cycle is set up as 512KiB.
Note that 512KiB(= 0x7ffff = 512 * 1024 * 1024) does not equals to 512KB (= 512 * 1000 * 1000).
To increase events per second on this plugin, specify larger value than 512KiB.

#### Query Languages for Event_Query Parameter

The `Event_Query` parameter can be used to specify the XML query for filtering Windows EventLog during collection.
Expand Down