docs: pipeline: inputs: ebpf: add trace_sched trace type and field docs#2605
Conversation
Document the new trace_sched eBPF trace added in fluent-bit (in_ebpf: Implement sched eBPF trace). Adds trace_sched to the list of selectable traces and a Sched trace fields table, and wraps technical terms in code spans to satisfy Vale. Note this documents a code change without corresponding docs PR. Signed-off-by: Eric D. Schabell <eric@schabell.org>
📝 WalkthroughWalkthroughThe eBPF input plugin documentation is updated to include ChangeseBPF trace_sched documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
pipeline/inputs/ebpf.md (1)
133-133:⚠️ Potential issue | 🟠 MajorUpdate
event_typecommon field to includesched.The
event_typefield documentation lists onlysignal,malloc,bind,exec,tcp, orvfsas possible values. With the newtrace_schedtrace type now documented (with 8 trace-specific fields:cpu,prev_pid,prev_prio,prev_state,next_pid,next_prio,runq_latency_ns,wakeup_tracked),schedevents will use the commonevent_typefield and should be included in the list. Update line 133 to includeschedas a possible value.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@pipeline/inputs/ebpf.md` at line 133, The `event_type` field documentation currently lists only signal, malloc, bind, exec, tcp, and vfs as possible values, but it needs to be updated to include sched since the new trace_sched trace type now uses the common event_type field. Update the event_type field description to add sched to the list of possible values alongside the existing event types.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@pipeline/inputs/ebpf.md`:
- Line 133: The `event_type` field documentation currently lists only signal,
malloc, bind, exec, tcp, and vfs as possible values, but it needs to be updated
to include sched since the new trace_sched trace type now uses the common
event_type field. Update the event_type field description to add sched to the
list of possible values alongside the existing event types.
|
@patrick-stephens ready for review! |
Document the new trace_sched eBPF trace added in fluent-bit
(in_ebpf: Implement sched eBPF trace). Adds trace_sched to the
list of selectable traces and a Sched trace fields table, and
wraps technical terms in code spans to satisfy Vale.
Note this documents a code change without corresponding docs PR.
Summary by CodeRabbit
Release Notes