in_ebp: add three missing config option descriptions. Fixes #11221.

[eschabell]

in_ebp: add three missing config option descriptions for:

ringbuf_map_name - should describe the BPF ring buffer map name
poll_ms - should describe the polling interval in milliseconds
Trace - should describe the trace type to enable (for example, bind, malloc, signal)

Fixes #11221

---

Testing
Before we can approve your change; please submit the following in a comment:

• [N/A ] Example configuration file for the change
• [N/A ] Debug log output from testing the change
• [N/A ] Attached Valgrind output that shows no leaks or memory corruption was found
• [N/A ] Run local packaging test showing all targets (including any new ones) build.
• [N/A ] Set ok-package-test label to test for all targets (requires maintainer to do).

Documentation

• Documentation required for this feature
  Issue: eBPF input plugin doc updates with config options. fluent-bit-docs#2239
  Doc PR: Updated ebpf input plugin doc with new config options and cleanup. Fixes #2239. fluent-bit-docs#2240

Backporting

• [N/A ] Backport to latest stable release.

---

Fluent Bit is licensed under Apache 2.0, by submitting this pull request I understand that this code will be released under the terms of that license.

Summary by CodeRabbit

• Documentation
  • Added descriptions for eBPF plugin configuration options: ring buffer map name, polling interval, and trace settings.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

The pull request adds missing description fields to three configuration options in the eBPF input plugin: ringbuf_map_name, poll_ms, and Trace. Each config entry in the config_map[] array now includes a descriptive string explaining its purpose, extending the existing FLB_CONFIG_MAP initializers.

Changes

Cohort / File(s)	Summary
eBPF plugin configuration descriptions plugins/in_ebpf/in_ebpf.c	Added description field to three config map entries: ringbuf_map_name (BPF ring buffer map name), poll_ms (polling interval in milliseconds), and Trace (trace type to enable, e.g., bind, malloc, signal). Descriptions are now exposed in help output.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Single file modification with straightforward, repetitive additions
• Three identical-pattern config entry updates with descriptive strings
• No functional logic changes; purely documentation/configuration data enhancement

Possibly related PRs

• fluent/fluent-bit#11206: Adds missing description strings to FLB_CONFIG_MAP initializers in the blob input plugin using the same pattern.

Suggested reviewers

• edsiper
• cosmo0920
• leonardo-albertovich

Poem

🐰 Through eBPF trails where traces flow,
We add descriptions—let users know!
Ring buffers, polls, and signals bright,
Now documented, crystal-light! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'in_ebp: add three missing config option descriptions' clearly and specifically describes the main change: adding descriptions to three in_ebpf config options.
Linked Issues check	✅ Passed	The PR adds descriptions for all three missing config options (ringbuf_map_name, poll_ms, Trace) as required by issue #11221, directly addressing the bug report.
Out of Scope Changes check	✅ Passed	All changes in the PR are confined to adding description fields for the three specified config options; no unrelated modifications detected.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 10ebd3a and d79ee40.

📒 Files selected for processing (1)

• plugins/in_ebpf/in_ebpf.c (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-11-21T06:23:29.770Z

Learnt from: cosmo0920
Repo: fluent/fluent-bit PR: 11171
File: include/fluent-bit/flb_lib.h:52-53
Timestamp: 2025-11-21T06:23:29.770Z
Learning: In Fluent Bit core (fluent/fluent-bit repository), function descriptions/documentation are not required for newly added functions in header files.

Applied to files:

• plugins/in_ebpf/in_ebpf.c

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

• GitHub Check: run-windows-unit-tests / call-build-windows-unit-test (Windows 64bit (Arm64), amd64_arm64, -DCMAKE_SYSTEM_NAME=Windows -DC...
• GitHub Check: run-windows-unit-tests / call-build-windows-unit-test (Windows 32bit, x86, x86-windows-static, 3.31.6, windows-latest)
• GitHub Check: run-windows-unit-tests / call-build-windows-unit-test (Windows 64bit, x64, x64-windows-static, 3.31.6, windows-latest)
• GitHub Check: run-qemu-ubuntu-unit-tests (riscv64)
• GitHub Check: run-qemu-ubuntu-unit-tests (s390x)

🔇 Additional comments (1)

plugins/in_ebpf/in_ebpf.c (1)

234-251: LGTM! Clear and accurate descriptions for all three config options.

The descriptions correctly document each option's purpose:

• ringbuf_map_name: Accurately describes the BPF ring buffer map name used to read events
• poll_ms: Correctly describes the polling interval in milliseconds
• Trace: Provides helpful examples and notes the multi-value capability (consistent with FLB_CONFIG_MAP_MULT flag)

This fulfills the objective of issue #11221—users will now see these descriptions when running ./fluent-bit -i ebpf -h.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[eschabell]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[DavidKorczynski]

The CIFuzz crashing here is not due to this PR, it is due to some infrastructure updates on OSS-Fuzz. Ref: #11227