From 0abca7cc688f2c75354917ea95afcbbb721fdf31 Mon Sep 17 00:00:00 2001 From: Lynette Miles Date: Wed, 2 Jul 2025 13:40:23 -0700 Subject: [PATCH 1/2] Pipeline: input: win event log2-: style Signed-off-by: Lynette Miles --- pipeline/inputs/windows-event-log.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/pipeline/inputs/windows-event-log.md b/pipeline/inputs/windows-event-log.md index 4a6941a40..f7bbefd0c 100644 --- a/pipeline/inputs/windows-event-log.md +++ b/pipeline/inputs/windows-event-log.md @@ -1,23 +1,23 @@ # Windows Event Log -The **winlog** input plugin allows you to read Windows Event Log. +The _Windows Event Log_ (`winlog`) input plugin lets you read the Windows Event Log. -## Configuration Parameters +## Configuration parameters The plugin supports the following configuration parameters: | Key | Description | Default | | ------------ | ----------------------------------------------------- | ------- | -| Channels | A comma-separated list of channels to read from. | | -| Interval_Sec | Set the polling interval for each channel. (optional) | 1 | -| DB | Set the path to save the read offsets. (optional) | | -| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` | +| `Channels` | A comma-separated list of channels to read from. | _none_ | +| `Interval_Sec` | Set the polling interval for each channel. (optional) | `1` | +| `DB` | Set the path to save the read offsets. (optional) | _none_ | +| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` | -Note that if you do not set _db_, the plugin will read channels from the beginning on each startup. +If `db` isn't set, the plugin will read channels from the beginning on each startup. -## Configuration Examples +## Configuration examples -### Configuration File +### Configuration file Here is a minimum configuration example. @@ -33,12 +33,12 @@ Here is a minimum configuration example. Match * ``` -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. +Some Windows Event Log channels, like `Security` require administrative privileges for reading. In this case, you need to run Fluent Bit as an administrator. -### Command Line +### Command line -If you want to do a quick test, you can run this plugin from the command line. +If you want to do a test, you can run this plugin from the command line. ```bash -$ fluent-bit -i winlog -p 'channels=Setup' -o stdout +fluent-bit -i winlog -p 'channels=Setup' -o stdout ``` From d776a65a21ad29c7e16f5f95cf210bcd60f3effc Mon Sep 17 00:00:00 2001 From: Lynette Miles <6818907+esmerel@users.noreply.github.com> Date: Thu, 3 Jul 2025 10:38:06 -0700 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Craig Norris <112565517+cnorris-cs@users.noreply.github.com> Signed-off-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> --- pipeline/inputs/windows-event-log.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pipeline/inputs/windows-event-log.md b/pipeline/inputs/windows-event-log.md index f7bbefd0c..59ef55bc9 100644 --- a/pipeline/inputs/windows-event-log.md +++ b/pipeline/inputs/windows-event-log.md @@ -33,11 +33,11 @@ Here is a minimum configuration example. Match * ``` -Some Windows Event Log channels, like `Security` require administrative privileges for reading. In this case, you need to run Fluent Bit as an administrator. +Some Windows Event Log channels, like `Security`, require administrative privileges for reading. In this case, you need to run Fluent Bit as an administrator. ### Command line -If you want to do a test, you can run this plugin from the command line. +If you want to do a test, you can run this plugin from the command line: ```bash fluent-bit -i winlog -p 'channels=Setup' -o stdout