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

eschabell · 2025-11-28T12:35:13Z

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 · 2025-11-28T12:35:30Z

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 marker comment 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

Focus review on ensuring all struct flb_config_map initializers across the codebase were updated to include the new description field.
Verify build and help output for plugins that use config_map.

Possibly related PRs

in_elasticsearch: fixing missing config parameter description for http2. Fixes #11221. #11226 — Adds missing description strings to plugin config_map entries (same change pattern).
in_http: added missing config parameter descriptions. #11240 — Adds missing config parameter description strings to plugin config_map entries (related plugin changes).

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 accurately describes the main change: adding three missing config option descriptions for the in_ebpf plugin, directly addressing the linked issue.
Linked Issues check	✅ Passed	The PR successfully implements all three required config option descriptions (ringbuf_map_name, poll_ms, Trace) as specified in issue #11221.
Out of Scope Changes check	✅ Passed	All changes are directly scoped to adding the three missing descriptions; no extraneous modifications were introduced.

✨ 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 03ae324 and 73a7598.

📒 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

🪛 Cppcheck (2.18.0)

plugins/in_ebpf/in_ebpf.c

[information] Limiting analysis of branches. Use --check-level=exhaustive to analyze all branches.

(normalCheckLevelMaxBranches)

[information] Too many #ifdef configurations - cppcheck only checks 12 configurations. Use --force to check all configurations. For more details, use --enable=information.

(toomanyconfigs)

⏰ 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, x64, x64-windows-static, 3.31.6)
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 32bit, x86, x86-windows-static, 3.31.6)
GitHub Check: run-ubuntu-unit-tests (-DFLB_COVERAGE=On, 3.31.6, gcc, g++)
GitHub Check: run-ubuntu-unit-tests (-DFLB_ARROW=On, 3.31.6, gcc, g++)
GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_THREAD=On, 3.31.6, gcc, g++)
GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_UNDEFINED=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_SIMD=Off, 3.31.6, gcc, g++)
GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_UNDEFINED=On, 3.31.6, gcc, g++)
GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=Off, 3.31.6, clang, clang++)
GitHub Check: run-ubuntu-unit-tests (-DFLB_COMPILER_STRICT_POINTER_TYPES=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_SANITIZE_THREAD=On, 3.31.6, clang, clang++)
GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_MEMORY=On, 3.31.6, gcc, g++)
GitHub Check: run-ubuntu-unit-tests (-DFLB_SMALL=On, 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 (-DFLB_SANITIZE_MEMORY=On, 3.31.6, clang, clang++)
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, clang, clang++)
GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_ADDRESS=On, 3.31.6, gcc, g++)
GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=On, 3.31.6, clang, clang++)
GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=Off, 3.31.6, gcc, g++)
GitHub Check: run-ubuntu-unit-tests (-DFLB_SMALL=On, 3.31.6, clang, clang++)
GitHub Check: PR - fuzzing test
GitHub Check: pr-compile-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, clang, clang++, ubuntu-24.04, clang-14)
GitHub Check: pr-compile-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, gcc, g++, ubuntu-24.04, clang-14)
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-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, gcc, g++, ubuntu-22.04, clang-12)
GitHub Check: pr-compile-without-cxx (3.31.6)
GitHub Check: pr-compile-centos-7

🔇 Additional comments (1)

plugins/in_ebpf/in_ebpf.c (1)

234-250: LGTM! Config descriptions successfully added.

The three config option descriptions are clear, accurate, and directly address issue #11221:

ringbuf_map_name: Correctly describes the BPF ring buffer map name (verified against usage at line 48)

poll_ms: Accurately describes the polling interval in milliseconds (verified against usage at line 182)

Trace: Properly describes the trace type with helpful examples and notes the multi-value capability (matches the FLB_CONFIG_MAP_MULT flag and manual processing at lines 165-177)

The struct initialization syntax is correct, and the EOF comment marker is a good practice.

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.}

eschabell · 2025-11-28T13:16:06Z

@coderabbitai review

coderabbitai · 2025-11-28T13:16:49Z

✅ 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 · 2025-11-28T16:37:57Z

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

edsiper · 2025-12-03T15:50:02Z

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

eschabell · 2025-12-04T09:09:55Z

@edsiper fixed the commit messages.

Add descriptions for three config options that were missing documentation: - log_encoder - log_encoding (with typo fix) - gelf_*_key options Fixes fluent#11221. Signed-off-by: Eric D. Schabell <eric@schabell.org>

eschabell · 2025-12-09T13:18:35Z

@edsiper squashed commits.

eschabell requested review from cosmo0920 and edsiper as code owners November 28, 2025 12:35

github-actions bot added the docs-required label Nov 28, 2025

eschabell temporarily deployed to pr November 28, 2025 12:35 — with GitHub Actions Inactive

eschabell temporarily deployed to pr November 28, 2025 12:36 — with GitHub Actions Inactive

eschabell temporarily deployed to pr November 28, 2025 12:55 — with GitHub Actions Inactive

cosmo0920 approved these changes Dec 1, 2025

View reviewed changes

cosmo0920 modified the milestones: Fluent Bit v4.2.1, Fluent Bit v5.0 Dec 3, 2025

eschabell force-pushed the erics_in_ebpf_config_fixes branch from d79ee40 to 8939816 Compare December 4, 2025 09:06

eschabell temporarily deployed to pr December 4, 2025 09:06 — with GitHub Actions Inactive

eschabell force-pushed the erics_in_ebpf_config_fixes branch from 8939816 to 03ae324 Compare December 4, 2025 09:09

eschabell temporarily deployed to pr December 4, 2025 09:09 — with GitHub Actions Inactive

eschabell temporarily deployed to pr December 4, 2025 09:28 — with GitHub Actions Inactive

in_ebpf: add missing config option descriptions

73a7598

Add descriptions for three config options that were missing documentation: - log_encoder - log_encoding (with typo fix) - gelf_*_key options Fixes fluent#11221. Signed-off-by: Eric D. Schabell <eric@schabell.org>

eschabell force-pushed the erics_in_ebpf_config_fixes branch from 03ae324 to 73a7598 Compare December 9, 2025 13:17

eschabell temporarily deployed to pr December 9, 2025 13:18 — with GitHub Actions Inactive

eschabell temporarily deployed to pr December 9, 2025 13:38 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

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

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

Uh oh!

eschabell commented Nov 28, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Nov 28, 2025 •

edited

Loading

Uh oh!

eschabell commented Nov 28, 2025

Uh oh!

coderabbitai bot commented Nov 28, 2025

Uh oh!

DavidKorczynski commented Nov 28, 2025 •

edited

Loading

Uh oh!

edsiper commented Dec 3, 2025

Uh oh!

eschabell commented Dec 4, 2025

Uh oh!

eschabell commented Dec 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

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

Are you sure you want to change the base?

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

Uh oh!

Conversation

eschabell commented Nov 28, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Nov 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

eschabell commented Nov 28, 2025

Uh oh!

coderabbitai bot commented Nov 28, 2025

Uh oh!

DavidKorczynski commented Nov 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

edsiper commented Dec 3, 2025

Uh oh!

eschabell commented Dec 4, 2025

Uh oh!

eschabell commented Dec 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

eschabell commented Nov 28, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 28, 2025 •

edited

Loading

DavidKorczynski commented Nov 28, 2025 •

edited

Loading