Skip to content

docs: service-section: document undocumented config parameters#2376

Merged
eschabell merged 2 commits intofluent:masterfrom
eschabell:erics_service_section_fixes
Feb 13, 2026
Merged

docs: service-section: document undocumented config parameters#2376
eschabell merged 2 commits intofluent:masterfrom
eschabell:erics_service_section_fixes

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Feb 13, 2026

  • Add dns.prefer_ipv4, dns.prefer_ipv6, and dns.resolver parameters
  • Add enable_chunk_trace parameter
  • Add health_check, hc_errors_count, hc_period, and hc_retry_failure_count parameters
  • Add hot_reload.ensure_thread_safety and hot_reload.timeout parameters
  • Add multiline_buffer_limit parameter
  • Add storage.inherit, storage.trim_files, and storage.type parameters
  • Sort service table and storage table alphabetically by key
  • Fix scheduler.base table column spacing
  • Fix grammar in configuration example description

Fixes #2375

Summary by CodeRabbit

  • Documentation
    • Added documentation for many new service configuration options: DNS preferences, HTTP server settings, JSON conversion behavior, multiline buffering, scheduler tuning, and health/check parameters.
    • Expanded and reorganized storage configuration guidance with granular backlog, retention, sync and metrics settings, plus updated examples and explanatory flow for monitoring and backpressure.
  • Chores
    • Added a spelling exception for hostnames.

@eschabell eschabell self-assigned this Feb 13, 2026
@eschabell eschabell requested a review from a team as a code owner February 13, 2026 11:38
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0 labels Feb 13, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 13, 2026

📝 Walkthrough

Walkthrough

Updated the Fluent Bit service section documentation: added many new top-level and storage-related configuration keys, reorganized and migrated several existing storage keys into a more granular schema, introduced health/check and DNS/http-related keys, and added a spelling exception for "hostnames". Total diff: +34/−20 lines.

Changes

Cohort / File(s) Summary
Service Section Documentation
administration/configuring-fluent-bit/yaml/service-section.md
Expanded service keys (e.g., coro_stack_size, dns.prefer_ipv4, dns.prefer_ipv6, dns.resolver, enable_chunk_trace, http_listen, http_server, json.convert_nan_to_null, json.escape_unicode, multiline_buffer_limit, scheduler.base, scheduler.cap, sp.convert_from_str_to_num, windows.maxstdio), reorganized storage into granular keys (storage.*, storage.backlog.*, storage.inherit, storage.keep.rejected, storage.metrics, storage.trim_files, storage.type, etc.), added health/check keys (hc_*) and updated example wording and flow.
Style / Spelling Exceptions
vale-styles/FluentBit/Spelling-exceptions.txt
Added new spelling exception: hostnames.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰
Keys hop quietly into place,
Storage paths find their space,
Docs trimmed, polished, and neat—
Fluent Bit's tune is complete.

🚥 Pre-merge checks | ✅ 6
✅ Passed checks (6 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: documenting previously undocumented configuration parameters in the service section.
Linked Issues check ✅ Passed The PR successfully addresses all coding requirements from issue #2375: adds missing configuration parameters (dns, enable_chunk_trace, health_check variants, hot_reload variants, multiline_buffer_limit, storage variants), sorts tables alphabetically, and fixes formatting issues.
Out of Scope Changes check ✅ Passed All changes are in scope: documentation updates to service-section.md for missing parameters and formatting, plus a spelling exception addition directly supporting the documentation improvements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into master

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

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
administration/configuring-fluent-bit/yaml/service-section.md (1)

45-57: Comprehensive storage configuration documentation.

The storage configuration table is well-organized and complete. Notable improvements:

  • storage.backlog.flush_on_shutdown (line 45) provides balanced trade-off information
  • storage.inherit and storage.type (lines 49, 57) work together with clear cross-references
  • Alphabetical ordering improves discoverability

The table successfully addresses the PR objective to document missing storage parameters.

Optional: Consider simplifying line 57 wording

Static analysis suggests the phrase "in conjunction with" on line 57 might be simplified to "with" for brevity:

-| `storage.type` | Sets the default storage type for input plugins. Used in conjunction with `storage.inherit` to apply this type to all inputs that don't explicitly set their own `storage.type`. Possible values: `memory`, `filesystem`, `memrb`. | _none_ |
+| `storage.type` | Sets the default storage type for input plugins. Used with `storage.inherit` to apply this type to all inputs that don't explicitly set their own `storage.type`. Possible values: `memory`, `filesystem`, `memrb`. | _none_ |

However, the current wording is perfectly clear and acceptable.


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

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR enhances the Fluent Bit service section documentation by adding previously undocumented configuration parameters, alphabetically sorting configuration tables, fixing column spacing, and correcting grammar. This addresses issue #2375 which identified missing parameters and needed updates across the service section documentation.

Changes:

  • Added 16 previously undocumented configuration parameters (DNS settings, chunk tracing, health check options, hot reload settings, multiline buffer limit, and storage options)
  • Alphabetically sorted both the main service table and storage configuration table for better readability
  • Fixed grammar in the configuration example description

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@eschabell eschabell force-pushed the erics_service_section_fixes branch 2 times, most recently from deea1dd to b340c28 Compare February 13, 2026 11:46
@eschabell eschabell requested a review from Copilot February 13, 2026 11:52
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@administration/configuring-fluent-bit/yaml/service-section.md`:
- Line 20: The table's hot_reload link is using the wrong relative path; update
the link target for the `hot_reload` table entry to match the example by
changing `../../../administration/hot-reload.md` to `../../hot-reload.md` so the
`hot_reload` link resolves correctly from this file's location.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  - Add dns.prefer_ipv4, dns.prefer_ipv6, and dns.resolver parameters
  - Add enable_chunk_trace parameter
  - Add health_check, hc_errors_count, hc_period, and hc_retry_failure_count
  parameters
  - Add hot_reload.ensure_thread_safety and hot_reload.timeout parameters
  - Add multiline_buffer_limit parameter
  - Add storage.inherit, storage.trim_files, and storage.type parameters
  - Sort service table and storage table alphabetically by key
  - Fix scheduler.base table column spacing
  - Fix grammar in configuration example description
  - Standardize "Accepted values:" to "Possible values:" for consistency

Fixes fluent#2375

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell force-pushed the erics_service_section_fixes branch from f97a549 to 410f644 Compare February 13, 2026 13:05
Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell merged commit dbbe7ed into fluent:master Feb 13, 2026
8 checks passed
@eschabell eschabell deleted the erics_service_section_fixes branch February 13, 2026 13:15
@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Feb 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Service section doc is missing configuration parameters and other updates needed.

2 participants