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 user-facing descriptions for eBPF plugin configuration options:
    • ring buffer map name: clarifies which ring buffer to read events from.
    • polling interval: clarifies the interval (ms) used to collect events.
    • trace settings: explains how to specify eBPF traces and that the option can be provided multiple times.

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

[coderabbitai]

Walkthrough

Added description strings to each config_map entry in the eBPF input plugin and updated the public config map structure to include a description member so the options ringbuf_map_name, poll_ms, and Trace now have help text.

Changes

Cohort / File(s)	Summary
eBPF plugin config plugins/in_ebpf/in_ebpf.c	Added description strings to three config_map entries: ringbuf_map_name ("Set the name of the eBPF ring buffer map to read events from"), poll_ms ("Set the polling interval in milliseconds for collecting events"), and Trace ("Set the eBPF trace to enable (for example, bind, malloc, signal). Can be set multiple times"). Added EOF placeholder in the array.
Public config map declaration include/...flb_config_map*	Public struct flb_config_map now includes a description (const char *) member so config entries can carry descriptive strings (initializers updated accordingly).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Changes are a small, consistent addition of description strings and one struct member.
• Verify all references/initializers of struct flb_config_map are updated to avoid initializer mismatches.
• Confirm help output and build/testing pass.

Possibly related PRs

• in_opentelemetry: added five missing configuration option descriptions. Fixes #11191. #11192 — Adds description strings to plugin config_map entries (same change pattern).
• in_blob: added missing configuration descriptions. Fixes #11204. #11206 — Adds missing description strings to flb_config_map initializers across plugins.

Suggested reviewers

• edsiper
• cosmo0920

Poem

🐰 I hopped through code to leave a clue,
Ringbuf, poll, and Trace — now told true.
Tiny strings that softly gleam,
Guiding users like a dream. ✨

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 clearly and specifically describes the main change: adding missing config option descriptions to the in_ebpf plugin, with reference to issue #11221.
Linked Issues check	✅ Passed	The pull request successfully addresses all coding requirements from #11221: descriptions added for ringbuf_map_name, poll_ms, and Trace config options matching the issue specifications.
Out of Scope Changes check	✅ Passed	All changes are directly related to adding descriptions for the three in_ebpf config options specified in #11221; 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 8939816 and 03ae324.

📒 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). (31)

• GitHub Check: pr-windows-build / call-build-windows-package (Windows 64bit (Arm64), amd64_arm64, -DCMAKE_SYSTEM_NAME=Windows -DCMA...
• GitHub Check: pr-windows-build / call-build-windows-package (Windows 64bit, x64, x64-windows-static, 3.31.6)
• GitHub Check: pr-windows-build / call-build-windows-package (Windows 32bit, x86, x86-windows-static, 3.31.6)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=Off, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_THREAD=On, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_COMPILER_STRICT_POINTER_TYPES=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_ARROW=On, 3.31.6, gcc, g++)
• GitHub Check: pr-compile-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, gcc, g++, ubuntu-22.04, clang-12)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_MEMORY=On, 3.31.6, clang, clang++)
• GitHub Check: pr-compile-without-cxx (3.31.6)
• GitHub Check: PR - fuzzing test
• GitHub Check: pr-compile-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, gcc, g++, ubuntu-24.04, clang-14)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_THREAD=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_ADDRESS=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=Off, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=Off, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_UNDEFINED=On, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_UNDEFINED=On, 3.31.6, gcc, g++)
• GitHub Check: pr-compile-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, clang, clang++, ubuntu-24.04, clang-14)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SMALL=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=On, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_COVERAGE=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_MEMORY=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=Off, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_ADDRESS=On, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=On, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SMALL=On, 3.31.6, clang, clang++)
• GitHub Check: pr-compile-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, clang, clang++, ubuntu-22.04, clang-12)
• GitHub Check: pr-compile-centos-7

🔇 Additional comments (1)

plugins/in_ebpf/in_ebpf.c (1)

233-251: LGTM! Config descriptions correctly added.

The descriptions for all three configuration options are clear, accurate, and follow the expected flb_config_map structure. The Trace entry appropriately notes that it can be set multiple times, which aligns with the FLB_CONFIG_MAP_MULT flag and the manual handling in in_ebpf_init.

---

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

[edsiper]

let's cleanup the history of this PR (commits)

[eschabell]

@edsiper fixed the commit messages.