service: add thread.flush_on_shutdown option

[jinyongchoi]

Summary

This commit adds documentation for the new thread.flush_on_shutdown configuration option in the SERVICE section.

When enabled, the engine waits for threaded input ring buffers to flush during graceful shutdown, preventing data loss from threaded inputs.

Changed files

• administration/configuring-fluent-bit/yaml/service-section.md
• administration/configuring-fluent-bit/classic-mode/configuration-file.md

Related PR

fluent/fluent-bit#11337

Summary by CodeRabbit

• Documentation
  • Added the public configuration key thread.flush_on_shutdown to the Service section documentation. The entry documents accepted values (on/off) and default (off). Check the updated service configuration docs for details.

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

[coderabbitai]

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

📝 Walkthrough

Walkthrough

Added documentation for a new Service configuration key thread.flush_on_shutdown in two docs. It documents enabling flushing of threaded input ring buffers during graceful shutdown to prevent data loss. Accepted values: on/off. Default: off.

Changes

Cohort / File(s)	Summary
Service Section Documentation administration/configuring-fluent-bit/classic-mode/configuration-file.md, administration/configuring-fluent-bit/yaml/service-section.md	Added thread.flush_on_shutdown configuration key entry describing graceful shutdown behavior for threaded input ring buffers (values: on/off, default: off).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

• alexakreizinger
• cosmo0920

Poem

🐇 I hopped through docs with pen so light,
A flush option added for shutdowns at night.
Rings unwind softly, no bytes gone wrong,
I thump my foot and sing a tiny song.

🚥 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 'service: add thread.flush_on_shutdown option' clearly and concisely describes the main change: adding a new configuration option to the service section.
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.}

---

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

[Copilot]

Pull request overview

This PR adds documentation for the new thread.flush_on_shutdown configuration option in the SERVICE section of Fluent Bit. This option controls whether the engine waits for threaded input ring buffers to flush during graceful shutdown, preventing data loss from threaded inputs.

Changes:

• Added documentation for the thread.flush_on_shutdown option with description, accepted values, and default value
• Documentation updated in both YAML and classic mode configuration files for consistency

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
administration/configuring-fluent-bit/yaml/service-section.md	Added thread.flush_on_shutdown option to the service section table with description, accepted values, and default value
administration/configuring-fluent-bit/classic-mode/configuration-file.md	Added thread.flush_on_shutdown option to the Service section table with description, allowed values, and default value

---

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

[Copilot]

Pull request overview

Copilot reviewed 2 out of 2 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.

[jinyongchoi]

The related code PR (fluent/fluent-bit#11337) is included in the 5.0.0 milestone.
Thanks!

[patrick-stephens]

Yeah we cannot merge until the change is in a release otherwise it'll confuse people

[eschabell]

Looks good!

[eschabell]

@jinyongchoi just waiting on the code PR to merge, thanks for this PR!