-
Notifications
You must be signed in to change notification settings - Fork 501
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
input: winlog: document the new Windows Event Log plugin (#176)
A new input plugin for handling Windows Event Log is being submitted as pull request #1378 on fluent/fluent-bit. This adds documentation for it, with the full list of configurable params and a couple of usage examples. Signed-off-by: Fujimoto Seiji <[email protected]>
- Loading branch information
Showing
1 changed file
with
48 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Winlog | ||
|
||
The **winlog** input plugin allows you to read Windows Event Log. | ||
|
||
Content: | ||
|
||
* [Configuration Parameters](winlog.md#config) | ||
* [Configuration Examples](winlog.md#config_example) | ||
|
||
## Configuration Parameters {#config} | ||
|
||
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) | | | ||
|
||
Note that if you do not set _db_, the plugin will read channels from the beginning on each startup. | ||
|
||
## Configuration Examples {#config_example} | ||
|
||
### Configuration File | ||
|
||
Here is a minimum configuration example. | ||
|
||
```python | ||
[INPUT] | ||
Name winlog | ||
Channels Setup,Windows PowerShell | ||
Interval_Sec 1 | ||
DB winlog.sqlite | ||
|
||
[OUTPUT] | ||
Name stdout | ||
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. | ||
|
||
### Command Line | ||
|
||
If you want to do a quick test, you can run this plugin from the command line. | ||
|
||
```bash | ||
$ fluent-bit -i winlog -p 'channels=Setup' -o stdout | ||
``` |