|
1 | 1 | # Windows Event Log |
2 | 2 |
|
3 | | -The **winlog** input plugin allows you to read Windows Event Log. |
| 3 | +The _Windows Event Log_ (`winlog`) input plugin lets you read the Windows Event Log. |
4 | 4 |
|
5 | | -## Configuration Parameters <a href="config" id="config"></a> |
| 5 | +## Configuration parameters |
6 | 6 |
|
7 | 7 | The plugin supports the following configuration parameters: |
8 | 8 |
|
9 | 9 | | Key | Description | Default | |
10 | 10 | | ------------ | ----------------------------------------------------- | ------- | |
11 | | -| Channels | A comma-separated list of channels to read from. | | |
12 | | -| Interval_Sec | Set the polling interval for each channel. (optional) | 1 | |
13 | | -| DB | Set the path to save the read offsets. (optional) | | |
14 | | -| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` | |
| 11 | +| `Channels` | A comma-separated list of channels to read from. | _none_ | |
| 12 | +| `Interval_Sec` | Set the polling interval for each channel. (optional) | `1` | |
| 13 | +| `DB` | Set the path to save the read offsets. (optional) | _none_ | |
| 14 | +| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` | |
15 | 15 |
|
16 | | -Note that if you do not set _db_, the plugin will read channels from the beginning on each startup. |
| 16 | +If `db` isn't set, the plugin will read channels from the beginning on each startup. |
17 | 17 |
|
18 | | -## Configuration Examples <a href="config_example" id="config_example"></a> |
| 18 | +## Configuration examples |
19 | 19 |
|
20 | | -### Configuration File |
| 20 | +### Configuration file |
21 | 21 |
|
22 | 22 | Here is a minimum configuration example. |
23 | 23 |
|
@@ -52,15 +52,12 @@ pipeline: |
52 | 52 | Match * |
53 | 53 | ``` |
54 | 54 |
|
55 | | -{% endtab %} |
56 | | -{% endtabs %} |
57 | | - |
58 | | -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. |
| 55 | +Some Windows Event Log channels, like `Security`, require administrative privileges for reading. In this case, you need to run Fluent Bit as an administrator. |
59 | 56 |
|
60 | | -### Command Line |
| 57 | +### Command line |
61 | 58 |
|
62 | | -If you want to do a quick test, you can run this plugin from the command line. |
| 59 | +If you want to do a test, you can run this plugin from the command line: |
63 | 60 |
|
64 | | -```shell |
65 | | -$ ./fluent-bit -i winlog -p 'channels=Setup' -o stdout |
66 | | -``` |
| 61 | +```bash |
| 62 | +fluent-bit -i winlog -p 'channels=Setup' -o stdout |
| 63 | +``` |
0 commit comments