Skip to content

Commit 4156e5e

Browse files
authored
Merge pull request #1841 from fluent/lynettemiles/sc-136211/update-fluent-bit-docs-pipeline-inputs-windows
2 parents a6431c9 + 19a42a6 commit 4156e5e

File tree

1 file changed

+15
-18
lines changed

1 file changed

+15
-18
lines changed

pipeline/inputs/windows-event-log.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
# Windows Event Log
22

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.
44

5-
## Configuration Parameters <a href="config" id="config"></a>
5+
## Configuration parameters
66

77
The plugin supports the following configuration parameters:
88

99
| Key | Description | Default |
1010
| ------------ | ----------------------------------------------------- | ------- |
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` |
1515

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.
1717

18-
## Configuration Examples <a href="config_example" id="config_example"></a>
18+
## Configuration examples
1919

20-
### Configuration File
20+
### Configuration file
2121

2222
Here is a minimum configuration example.
2323

@@ -52,15 +52,12 @@ pipeline:
5252
Match *
5353
```
5454

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.
5956

60-
### Command Line
57+
### Command line
6158

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:
6360

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

Comments
 (0)