Skip to content

docs: pipeline: inputs: ebpf: add trace_sched trace type and field docs#2605

Merged
patrick-stephens merged 1 commit into
fluent:masterfrom
eschabell:erics_in_ebpf_updates
Jun 22, 2026
Merged

docs: pipeline: inputs: ebpf: add trace_sched trace type and field docs#2605
patrick-stephens merged 1 commit into
fluent:masterfrom
eschabell:erics_in_ebpf_updates

Conversation

@eschabell

@eschabell eschabell commented Jun 20, 2026

Copy link
Copy Markdown
Collaborator

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

  • Documentation
    • Enhanced eBPF trace configuration guide with improved examples showing multiple trace type enablement.
    • Added comprehensive scheduling trace field documentation detailing available record parameters.

  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>
@eschabell eschabell self-assigned this Jun 20, 2026
@eschabell eschabell requested a review from a team as a code owner June 20, 2026 13:06
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0.7 labels Jun 20, 2026
@coderabbitai

coderabbitai Bot commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The eBPF input plugin documentation is updated to include trace_sched in the trace configuration parameter example list and to add a new "Sched" trace fields section documenting the eight record fields emitted by the trace_sched event.

Changes

eBPF trace_sched documentation

Layer / File(s) Summary
trace_sched config entry and Sched fields section
pipeline/inputs/ebpf.md
The trace configuration table row now lists trace_sched among enabled example traces. A new Sched trace fields section documents eight fields: cpu, prev_pid, prev_prio, prev_state, next_pid, next_prio, runq_latency_ns, and wakeup_tracked.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • fluent/fluent-bit-docs#2601: Adds trace_dns to the eBPF trace example list and documents DNS fields — the direct predecessor to this PR's trace_sched additions.
  • fluent/fluent-bit-docs#2571: Extends pipeline/inputs/ebpf.md by adding trace_exec example name and a dedicated exec trace fields section, the same pattern used here for trace_sched.
  • fluent/fluent-bit-docs#2534: Also modifies pipeline/inputs/ebpf.md's trace documentation to add new eBPF trace types and corresponding field sections.

Suggested reviewers

  • patrick-stephens
  • cosmo0920

Poem

🐇 Hop hop through the kernel queue,
A scheduler trace comes into view!
prev_pid, next_prio, latency too,
Run-queue secrets no longer eschew.
The docs now know what trace_sched can do! 🎉

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: adding documentation for the trace_sched trace type and its field documentation to the eBPF pipeline inputs documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 | 🟠 Major

Update event_type common field to include sched.

The event_type field documentation lists only signal, malloc, bind, exec, tcp, or vfs as possible values. With the new trace_sched trace type now documented (with 8 trace-specific fields: cpu, prev_pid, prev_prio, prev_state, next_pid, next_prio, runq_latency_ns, wakeup_tracked), sched events will use the common event_type field and should be included in the list. Update line 133 to include sched as 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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c7f4176f-dcd7-4519-9670-cdb30f5d1c35

📥 Commits

Reviewing files that changed from the base of the PR and between 0e328f4 and 57a04a5.

📒 Files selected for processing (1)
  • pipeline/inputs/ebpf.md

@eschabell

Copy link
Copy Markdown
Collaborator Author

@patrick-stephens ready for review!

@patrick-stephens patrick-stephens merged commit e2aadc6 into fluent:master Jun 22, 2026
8 checks passed
@eschabell eschabell deleted the erics_in_ebpf_updates branch June 23, 2026 08:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

5.0.7 waiting-on-review Waiting on a review from mainteners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants