docs: inputs: http: document enable_health_endpoint parameter#2548
docs: inputs: http: document enable_health_endpoint parameter#2548eschabell merged 1 commit intofluent:masterfrom
Conversation
- add enable_health_endpoint configuration parameter to table - fix vale directional language suggestion Applies to code fix in 5.0.3 with no doc PR. Signed-off-by: Eric D. Schabell <eric@schabell.org>
📝 WalkthroughWalkthroughUpdated HTTP input documentation by revising wording in the configuration parameters section and introducing a new Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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.
🧹 Nitpick comments (1)
pipeline/inputs/http.md (1)
25-25: Consider adding version availability for this new parameter.Since this documents a 5.0.3 fix, adding an “Available in 5.0.3+” note in the description would reduce ambiguity for users on earlier versions.
Proposed doc tweak
-| `enable_health_endpoint` | Enable a `GET /health` endpoint for this input instance. When enabled, the endpoint returns a JSON response with `status` and `timestamp` fields. | `false` | +| `enable_health_endpoint` | Enable a `GET /health` endpoint for this input instance. When enabled, the endpoint returns a JSON response with `status` and `timestamp` fields. Available in Fluent Bit `5.0.3+`. | `false` |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@pipeline/inputs/http.md` at line 25, The docs entry for the parameter `enable_health_endpoint` lacks version availability; update its description to append a short availability note such as "Available in 5.0.3+" (or equivalent) so users know this flag was introduced in 5.0.3; locate the `enable_health_endpoint` table row in pipeline/inputs/http.md and modify the description cell to include the "Available in 5.0.3+" text.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@pipeline/inputs/http.md`:
- Line 25: The docs entry for the parameter `enable_health_endpoint` lacks
version availability; update its description to append a short availability note
such as "Available in 5.0.3+" (or equivalent) so users know this flag was
introduced in 5.0.3; locate the `enable_health_endpoint` table row in
pipeline/inputs/http.md and modify the description cell to include the
"Available in 5.0.3+" text.
|
@patrick-stephens ready for review! |
|
Merging on AI review. |
Applies to code fix in 5.0.3 with no doc PR.
Summary by CodeRabbit
New Features
enable_health_endpointconfiguration parameter for HTTP input, enabling a GET/healthendpoint that returns JSON with status and timestamp (default: disabled).Documentation