Skip to content

Commit 4f5e12f

Browse files
authored
docs: inputs: ebpf: document tcp trace type (#2549)
1 parent c5811f5 commit 4f5e12f

1 file changed

Lines changed: 18 additions & 2 deletions

File tree

pipeline/inputs/ebpf.md

Lines changed: 18 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`, `trace_vfs`). 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_tcp`, `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`, `bind`, or `vfs`). |
133+
| `event_type` | Type of event (`signal`, `malloc`, `bind`, `tcp`, 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. |
@@ -166,6 +166,22 @@ The `trace_bind` trace includes these additional fields:
166166
| `bound_dev_if` | Network device interface the socket is bound to. |
167167
| `error_raw` | Error code for the bind operation (`0` indicates success). |
168168

169+
### TCP trace fields
170+
171+
The `trace_tcp` trace captures TCP connection lifecycle events and includes these additional fields:
172+
173+
| Field | Description |
174+
|:------|:------------|
175+
| `event_type` | TCP event subtype (`listen`, `accept`, or `connect`). |
176+
| `fd` | File descriptor for the socket. |
177+
| `backlog` | Listen backlog size (for `listen` events). |
178+
| `new_fd` | New file descriptor returned by the kernel (for `accept` events). |
179+
| `peer_port` | Remote peer port number (for `accept` events). |
180+
| `peer_addr` | Remote peer IP address (for `accept` events). |
181+
| `remote_port` | Remote port number (for `connect` events). |
182+
| `remote_addr` | Remote IP address (for `connect` events). |
183+
| `error_raw` | Error code for the operation (`0` indicates success). |
184+
169185
### `VFS` trace fields
170186

171187
The `trace_vfs` trace includes these additional fields:

0 commit comments

Comments
 (0)