service: add thread.flush_on_shutdown option #2332
Conversation
|
Note Other AI code review bot(s) detectedCodeRabbit 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. 📝 WalkthroughWalkthroughAdded documentation for a new Service configuration key Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ 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. Comment |
There was a problem hiding this comment.
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_shutdownoption 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.
| | --- | ----------- | ------------- | | ||
| | `flush` | Sets the flush time in `seconds.nanoseconds`. The engine loop uses a flush timeout to define when to flush the records ingested by input plugins through the defined output plugins. | `1` | | ||
| | `grace` | Sets the grace time in `seconds` as an integer value. The engine loop uses a grace timeout to define the wait time on exit. | `5` | | ||
| | `thread.flush_on_shutdown` | If enabled, the engine waits for threaded input ring buffers to flush during graceful shutdown, preventing data loss from threaded inputs. Accepted values: `off` or `on`. | `off` | |
There was a problem hiding this comment.
The terminology and order used here ("Accepted values: off or on") is inconsistent with line 10 which uses "Possible values: yes, no, on, and off." For consistency within this file, consider using "Possible values:" instead of "Accepted values:" and list the values in a consistent order (for boolean options, typically on is listed before off).
| | `thread.flush_on_shutdown` | If enabled, the engine waits for threaded input ring buffers to flush during graceful shutdown, preventing data loss from threaded inputs. Accepted values: `off` or `on`. | `off` | | |
| | `thread.flush_on_shutdown` | If enabled, the engine waits for threaded input ring buffers to flush during graceful shutdown, preventing data loss from threaded inputs. Possible values: `on` and `off`. | `off` | |
| | --------------- | ------------- | ------------- | | ||
| | `flush` | Set the flush time in `seconds.nanoseconds`. The engine loop uses a Flush timeout to define when it's required to flush the records ingested by input plugins through the defined output plugins. | `1` | | ||
| | `grace` | Set the grace time in `seconds` as an integer value. The engine loop uses a grace timeout to define wait time on exit. | `5` | | ||
| | `thread.flush_on_shutdown` | If enabled, the engine waits for threaded input ring buffers to flush during graceful shutdown, preventing data loss from threaded inputs. Allowed values are: `on` and `off`. | `off` | |
There was a problem hiding this comment.
The phrase "Allowed values are: on and off" is inconsistent with other similar entries in this file. Line 25 uses "Allowed values are: yes, no, on, and off" with commas to separate multiple values. However, this line uses "and" without commas for just two values. While grammatically both are correct, for consistency with similar entries (like daemon on line 25), consider using "on or off" or "on, off" format to align with how the table presents boolean options elsewhere in the documentation.
| | `thread.flush_on_shutdown` | If enabled, the engine waits for threaded input ring buffers to flush during graceful shutdown, preventing data loss from threaded inputs. Allowed values are: `on` and `off`. | `off` | | |
| | `thread.flush_on_shutdown` | If enabled, the engine waits for threaded input ring buffers to flush during graceful shutdown, preventing data loss from threaded inputs. Allowed values are: `on` or `off`. | `off` | |
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. refs: fluent/fluent-bit#11337 Signed-off-by: jinyong.choi <inimax801@gmail.com>
jinyongchoi
force-pushed
the
fix/11265-ring-buffer
branch
from
234442d to
b6c6850
Compare
There was a problem hiding this comment.
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.
1 participant
Summary
This commit adds documentation for the new
thread.flush_on_shutdownconfiguration 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.mdadministration/configuring-fluent-bit/classic-mode/configuration-file.mdRelated PR
fluent/fluent-bit#11337
Summary by CodeRabbit
thread.flush_on_shutdownto 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.