Skip to content

Commit 2f903bd

Browse files
author
Pavel Siska
committed
Raw: Add README
1 parent cde758d commit 2f903bd

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

src/plugins/input/raw/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Raw (Input Plugin)
2+
3+
The Raw input plugin allows you to capture network traffic from a specified interface using raw sockets. It uses a circular buffer to hold the captured packets and can be optimized for specific traffic processing needs.
4+
5+
## Example Configuration
6+
7+
```yaml
8+
input_plugin:
9+
raw:
10+
interface: "eth0"
11+
### Optional parameters
12+
blocks_count: 2048
13+
packets_in_block: 32
14+
```
15+
16+
## Parameters
17+
18+
**Mandatory Parameters**
19+
20+
|Parameter | Description |
21+
|---|---|
22+
|__interface__| Network interface name (e.g., eth0) from which to capture traffic |
23+
24+
**Optional parameters:**
25+
26+
|Parameter | Default | Description |
27+
|---|---|---|
28+
|__blocks_count__ | 2048 | Number of blocks in the circular buffer, must be a power of 2. |
29+
|__packets_in_block__ | 2048 | Number of packets per block, must be a power of 2. |

0 commit comments

Comments
 (0)