Skip to content

Commit 3da2d5f

Browse files
authored
docs: inputs: ebpf: document trace_vfs trace type (#2534)
- Update `trace` parameter description to list `trace_vfs` as an example - Update common `event_type` field to include `vfs` as a valid value - Add "`VFS` trace fields" section documenting operation, path, flags, mode, fd, and error_raw fields Fixes #2533 Signed-off-by: Eric D. Schabell <eric@schabell.org>
1 parent 8927998 commit 3da2d5f

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

pipeline/inputs/ebpf.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The plugin supports the following configuration parameters:
2020
|:----|:------------|:--------|
2121
| `poll_ms` | Set the polling interval in milliseconds for collecting events from the ring buffer. | `1000` |
2222
| `ringbuf_map_name` | Set the name of the eBPF ring buffer map to read events from. | `events` |
23-
| `trace` | Set the eBPF trace to enable (for example, `trace_bind`, `trace_malloc`, `trace_signal`). This parameter can be set multiple times to enable multiple traces. | _none_ |
23+
| `trace` | Set the eBPF trace to enable (for example, `trace_bind`, `trace_malloc`, `trace_signal`, `trace_vfs`). This parameter can be set multiple times to enable multiple traces. | _none_ |
2424

2525
## System dependencies
2626

@@ -130,7 +130,7 @@ All traces include the following fields:
130130

131131
| Field | Description |
132132
|:------|:------------|
133-
| `event_type` | Type of event (`signal`, `malloc`, or `bind`). |
133+
| `event_type` | Type of event (`signal`, `malloc`, `bind`, or `vfs`). |
134134
| `pid` | Process ID that generated the event. |
135135
| `tid` | Thread ID that generated the event. |
136136
| `comm` | Command name (process name) that generated the event. |
@@ -165,3 +165,16 @@ The `trace_bind` trace includes these additional fields:
165165
| `port` | Port number the socket is binding to. |
166166
| `bound_dev_if` | Network device interface the socket is bound to. |
167167
| `error_raw` | Error code for the bind operation (`0` indicates success). |
168+
169+
### `VFS` trace fields
170+
171+
The `trace_vfs` trace includes these additional fields:
172+
173+
| Field | Description |
174+
|:------|:------------|
175+
| `operation` | `VFS` operation type (integer). |
176+
| `path` | File path involved in the operation. |
177+
| `flags` | Flags passed to the `VFS` operation. |
178+
| `mode` | File mode bits for the operation. |
179+
| `fd` | File descriptor returned by the operation. |
180+
| `error_raw` | Error code for the operation (`0` indicates success). |

0 commit comments

Comments
 (0)