docs: service-section: document undocumented config parameters#2376
docs: service-section: document undocumented config parameters#2376eschabell merged 2 commits intofluent:masterfrom
Conversation
📝 WalkthroughWalkthroughUpdated 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
No actionable comments were generated in the recent review. 🎉 🧹 Recent nitpick comments
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 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.
deea1dd to
b340c28
Compare
There was a problem hiding this comment.
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.
b340c28 to
f97a549
Compare
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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>
f97a549 to
410f644
Compare
Signed-off-by: Eric D. Schabell <eric@schabell.org>
Fixes #2375
Summary by CodeRabbit