Skip to content

Conversation

@eschabell
Copy link
Contributor

@eschabell eschabell commented Jan 22, 2026

  • Add description for buffer_max_size configuration parameter

Fixes ##11385


Enter [N/A] in the box, if an item is not applicable to your change.

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

If this is a change to packaging of containers or native binaries then please confirm it works for all targets.

  • [ 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

  • [ Already in docs ] Documentation required for this feature

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
    • Enhanced help text descriptions for buffer configuration settings in Prometheus scraping options, providing clearer guidance to users.

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

  - Add description for buffer_max_size configuration parameter

Fixes #fluent#11385

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@coderabbitai
Copy link

coderabbitai bot commented Jan 22, 2026

📝 Walkthrough

Walkthrough

A help text description for the buffer_max_size configuration option in the Prometheus scrape plugin was updated from an empty string to a non-empty descriptive message, providing user-facing documentation for this configuration parameter.

Changes

Cohort / File(s) Summary
Prometheus Scrape Configuration Help Text
plugins/in_prometheus_scrape/prom_scrape.c
Updated the buffer_max_size configuration map entry with a non-empty description string to provide user-facing help text for this configuration option

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related issues

Suggested labels

docs-required

Suggested reviewers

  • edsiper
  • cosmo0920

Poem

🐰 A tiny fix with mighty grace,
Help text finds its rightful place,
Buffer size now speaks so clear,
Users smile from ear to ear! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 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 a missing description for the buffer_max_size configuration parameter in the in_prometheus_scrape plugin.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing touches
  • 📝 Generate docstrings

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.

Copy link
Collaborator

@patrick-stephens patrick-stephens left a comment

Choose a reason for hiding this comment

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

Trivial fix

@patrick-stephens patrick-stephens merged commit fb2cce4 into fluent:master Jan 23, 2026
60 checks passed
@eschabell eschabell deleted the erics_in_prometheus_scrape_fix branch January 23, 2026 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants